FileCloud 20 - 1 Sync
FileCloud 20 - 1 Sync
Version 20.1
User Guide for Sync
FileCloud Server Version 20.1 User Guide for Sync
Copyright Notice
© 2020 CodeLathe Technologies, Inc. All rights reserved.
While all reasonable care has been taken in the preparation of this document, no liability is accepted by the authors, CodeLathe Technologies, Inc., for any
errors, omissions or misstatements it may contain, or for any loss or damage, howsoever occasioned, to any person relying on any statement or omission
in this document.
Choose a mobile device to access files regardless of your location (iOS, Android, Windows Phone)
Choose which browser you want to use (Google Chrome, Internet Explorer, Mozilla Firefox, Oracle Opera, Apple Safari)
Choose the types of files you want to preview, sync and share (Adobe Illustrator, medical files, Microsoft WORD, Adobe PDF Reader,
Microsoft Office PowerPoint and Excel)
Although an administrator can configure these options differently, by default, you have the following storage and activity limits in the FileCloud system:
Type Description
Path limit No limit imposed by FileCloud server. However, If that path is synced,
then windows OS has 256 character limit. Any folder/file name with path
that exceeds 255 char will not be accessible via file explorers (Though
the folder contents will sync)
Please note that folder/file names of Excel files must not be longer than
218 characters: Excel specifications and limits
Folder or Multi file download Linux: No limit, Windows: 4GB (Zipped file size should not exceed 4GB)
Managed storage max single file size limit None imposed by system
Folder upload limit (Drag and drop in browser) 100 files or folder will be uploaded if a folder is uploaded using drag and
drop (No limit if uploading using file/folder chooser)
4
5
User Account Types
Once an enterprise installs FileCloud, the FileCloud administrator will provide each user with an account.
View Network Shares Permitted Permitted Only via shares created by users
Group Membership Can be member of any group Can be member of any group Not Available
Admin Account Can be Admin Account Can be Admin Account Cannot be an Admin Account
Once an user account is created, it can be assigned different access levels. There are four different access levels for an user account.
Admin Access
An account with admin access level has complete control over the FileCloud system. This account will be used to manage the FileCloud server instance.
Other users can be marked as 'admins' and given limited set of permissions.
Full Access
An account with full access has its own private cloud storage space in the "My Files" area. These users can:
Guest Access
An account with guest access level have restricted access to the FileCloud system. These user accounts do not have a private cloud storage. These users
can:
Limited Access
6
An account that can only be used to access the User Portal through a Web browser. Limited Accounts can:
7
Comparison of FileCloud Sync and Drive
You can use the following FileCloud tools to access and manage your files stored and shared in the cloud:
FileCloud Sync
FileCloud Drive
When would I use FileCloud Sync and when would I use FileCloud Drive?
Deciding on which tool to use depends on how you want to access and manage your files. It can also depend on some of the following factors:
Company policy
Internet connectivity
Security policies
Use the information in Table 1 to understand the difference in the tools and choose which is the best one for you. You can also decide to use them both!
USE CASES
Offline copy is needed for reasons such as traveling & intermittent Offline copy is not needed or not allowed per company policy
network access.
Team collaboration View FileCloud server files as a drive. User doesn't want files to be
downloaded for local copy. File downloaded only in edit.
Recommended when lots of files needs to be moved to the FileCloud Doesn't consume permanent storage. Ideal for newer laptops with SSDs
Server. The process is a lot more efficient than uploads. where hard disk capacity is limited
Locally view FileCloud files & have a selective and/or all files/folder from Scenario where you need access to TBs of files and don't want every
FileCloud as copy on Desktop file to be synced.
Better in editing large files such as AutoCAD Easier on bandwidth usage - all files doesn't need to be downloaded
and uploaded
Better when editing linked documents such as graphic files that link to
multiple other files.
CHALLENGES
Requires storage space on the HDD to store offline files Requires active and stable internet connection
Yes, synchronized with FIleCloud Server periodically Files are downloaded only on edit
Upon save, file is synchronized back to FileCloud server
No deliberate locking can be issued in FileCloud Sync client. Automatically lock on edit in FileCloud Drive.
As files are proactively synced between FileCloud Server & Sync If lock is not possible, edit will be prevented and server copy will
Client - Conflicts & updates are notified on Sync. not be changed
OTHER FEATURES
8
Selective Sync - Not all files under FileCloud is copied to Desktop Map FileCloud folders as a Drive
FileBrowser app to edit and browse all documents via a explorer like
interface
How does FileCloud Sync & Drive compare with WebDAV Clients?
You can download WebDAV clients to interact with your files on FileCloud Server.
Ideal for Editing Small Files Editing all Files Editing Small Files
Operating Systems Windows and MAC For Windows , MAC and LINUX For Windows , MAC and LINUX
Although FileCloud is compatible with WebDAV clients, CodeLathe does not provide it's own WebDAV client for FileCloud.
9
FileCloud Sync
You can use FileCloud Sync to keep a folder on any computer that is synchronized with your FileCloud server.
FileCloud Sync is a client application. This is because it allows you to access the FileCloud Server and the files you store there.
You can access files in Sync like you do on a Windows PC in Windows Explorer or Mac OSX Finder.
The same features that are available on the User Portal are also available in Sync.
Sync allows you to easily open the User Portal if you need to.
You can configure Network Folders to be automatically synchronized to your client.
You can back up Sync files for safekeeping
Sync includes an assistant to make it easy to access Sync files from Microsoft applications. In FileCloud Server version 18.2 and later.
Where Do I Start?
Share Files
Working with Sync
Synchronize Files
Manage Files
Offline Access
Back Up Files
Configuring Sync
Troubleshooting
Set Bandwidth Rate Limits
Troubleshooting Guide
10
11
Install FileCloud Sync
The ability to install the Share and Search integration with Windows Explorer is available in FileCloud Server version 18.2 and later.
The ability to install DocIQ is available in FileCloud Server version 18.2 and later.
You must install FileCloud Sync before you can begin synchronizing documents on your local computer to the FileCloud Server site.
You can install FileCloud Sync on computers running the following operating systems:
Windows
Mac OSX
Linux
12
Install Sync on Linux
The ability to install the Share and Search integration with Windows Explorer is available in FileCloud Server version 18.2 and later.
The ability to install DocIQ is available in FileCloud Server version 18.2 and later.
You must install FileCloud Sync before you can begin synchronizing documents on your local computer to the FileCloud Server site.
unzip filecloudsync_linux_amd64.zip
chmod +x filecloudsyncstart.sh
chmod +x filecloudsync
5. Open the terminal, go to the location where the FileCloud Sync files were extracted and then run filecloudsyncstart.sh
./filecloudsyncstart.sh
4. Open the terminal, go to the location where the FileCloud Sync files were extracted and then run
apt-get update
./filecloudsyncinstall-ubuntu.sh install
5. After these steps, Sync app will be shown along with the other desktop apps. Double-click the app to open it.
If Sync shows the message "There appears to be no system tray support in your current environment", then system tray support needs to be
enabled by downloading the extensions.
6. To download the necessary extensions, head to the TopIcons Plus extensions page on the official GNOME site. From here, click on "Click here to install
browser extension.", then click "Allow" and then "Add".
7. Return to the GNOME extensions page and refresh it. You may see the following message:
13
"Although GNOME Shell integration extension is running, native host connector is not detected. Refer documentation for instructions about installing
connector."
If so, click on the "documentation" link in the message. Here, choose your Linux version, and execute the corresponding command in the terminal.
8. Again, return to the GNOME Extensions page and refresh. Click the "Off/On" button to set it to On state. Then, click download and install option.
9. Once all the steps above have completed successfully, the Sync app can be started by double-clicking the Sync icon in the desktop apps.
14
Install Sync on Mac OSX
The ability to install the Share and Search integration with Windows Explorer is available in FileCloud Server version 18.2 and later.
The ability to install DocIQ is available in FileCloud Server version 18.2 and later.
You must install FileCloud Sync before you can begin synchronizing documents on your local computer to the FileCloud Server site.
15
16
Install Sync on Windows
The ability to install the Share and Search integration with Windows Explorer is available in FileCloud Server version 18.2 and later.
The ability to install DocIQ is available in FileCloud Server version 18.2 and later.
You must install FileCloud Sync before you can begin synchronizing documents on your local computer to the FileCloud Server site.
17
Log In to Sync Using SSO
Your Administrator may set it up so that you can enter one name and password in order to access multiple applications.
1. From the system tray, right-click the FileCloud Sync icon, and then click Settings.
2. On the Home screen, select the Settings tab.
3. On the Settings screen, click Use SSO.
4. Type in the following settings, and then click Login with SSO.
18
Use Device Authorization Code This allows you to get a Device Authorization Administrators can read about:
Code to connect to the server instead of a using
SSO or username and password.
Configuring Desktop Apps SSO Login
You administrator must configure this option. support - Code Based Authentication
1. You must enter the server URL, the user Using Device Authorization Codes
account name (or email), and then click the
"Request Access" button.
2. If the request access was successful, you
will get the following dialog which needs a
device authorization code to login.
Document Editing Only This turns off all synchronization while you are
logged in with these account settings.
(no sync)
You can only edit files that have already been
downloaded, and save your changes locally.
19
Start and Log In to Sync
After you install Sync and restart your computer if necessary, you must:
This allows you to edit or synchronize your files with the FileCloud Server.
You administrator can enable you to log in with Single Sign-On credentials.
2.
20
2. In FileCloud Sync Server URL, type the address to the FileCloud server that was sent to you when your FileCloud account was created.
3. In Account and Password, type in the credentials that were sent to you when your FileCloud account was created.
4. If you only want to edit files and not to sync changes back or get updates, select the Document editing only checkbox.
5. Optionally you can select an alternative language.
6. Click Login.
21
Sync Installer Options
Option Notes
/SILENT, /VERYSILENT Instructs Setup to be silent or very silent. When Setup is silent the wizard
and the background window are not displayed but the installation progress
window is. When a setup is very silent this installation progress window is
not displayed. If a restart is necessary and the '/NORESTART' command
isn't used and Setup is silent, it will display a Reboot now? message box.
If it's very silent it will reboot without asking.
/TASKS="explorerintegration" Installs the explorer integration add on when using the command line
22
Offline Access
You don't need to configure anything for your files (in the My Files folder) to get synced automatically.
23
Advanced Offline Sync mode
This is an advanced feature not meant for general use, please enable and use only if you need something specific that you need to accomplish.
Some users want the ability to control more exactly which local folders are synced to which remote folders and in which direction.
There is an "advanced mode" in sync that allows control of such options. To enable advanced mode, open the syncclientconfig.xml and add the following
entry
<rowentry>
<name>advancedoffline</name>
<type>bool</type>
<value>1</value>
</rowentry>
Windows %APPDATA%\FileCloudSync\syncclientconfig.xml
Linux {HomeDir}\FileCloudSync\syncclientconfig.xml
Then restart the sync app and right click on the sync app and select "Settings" -> "Settings"
24
2. In the "Add New Offline Folder"
Local to Remote This is one way sync, where only changes from local are synced to remote
server. No changes are synced from remote to local.
Remote to Local This is one way sync, where only changes from remote are synced to
local. No changes are synced from local to remote.
When a user tries to make any changes, the following message will be displayed - "Centralized Configuration is being applied. Settings cannot be
changed. Please contact your administrator for assistance."
25
Delete Remote Network Files
By default, local files and folders deleted do not get deleted on the remote server for security.
You can enable the FileCloud server to delete remote network files with offline access if necessary
Your administrator needs to configure Network Folder Details to allow you select this setting
1. In the System Tray, right-click on the FileCloud Drive icon, and then select Settings.
2. On the Settings window, in the Other Settings section, click Edit.
3. Click the Network Folders tab.
4. Next to Remote Delete, select the checkbox.
5. Click Save.
26
How Network Folder Offline Access Works
Unlike how My Files and other Synced folders are automatically synced, Offline Network Folders work differently.
Local Change Detection Immediate: When Local File Changes On a specific schedule or Manually
Remote Change Detection Change Detection of Remote Files is Efficient Change Detection of Remote Files is less
efficient than Synced Folders
FAQ's
If a file is changed locally and also modified independently remotely then when refresh happens, then the file will be marked as "Conflicted" and will
not be uploaded to the server. The user will have to manually resolve the conflict.
Network Folder Files are synced offline by the sync app, similar to how "My Files" are synced, but there are some fundamental differences. Network
Folders live outside FileCloud and can be modified and changed outside of FileCloud (via the LAN for example). As a result, FileCloud sync does not
know which files have been changed automatically. Therefore it has to request changes at regular interfaces to scan for changes and download the
changed files locally.
To reduce the potential server load when working with lots of network files, the offline sync only works at regular intervals instead of real-time.
You may or may not be able to make changes to Network Folders with Offline Access. This depends on how your Administrator has configured
FileCloud Server.
An administrator can control how the Sync app interacts with the FileCloud Server.
This is configured centrally by the administrator through the use of User Policies and Device Configuration settings in the Admin portal.
If an Admin is using central configuration, then Sync user cannot add or remove Network folders, or change the settings for any of the
existing Network Folders added through Centralized Configuration.
If you try to make any changes, you will see the following message:
"Centralized Configuration is being applied. Settings cannot be changed. Please contact your administrator for assistance."
27
Sync Network Folders for Offline Access
Note:
Your administrator has to enable Network Folders Offline access for this to work.
For a network folder to be able to Sync, Read and write permissions have to be available for the user. Read-only network folders are
not available for Sync.
Only files in My Files (Managed Storage) get synced automatically without user intervention.
Network Folders are typically very large, storing gigabytes (sometimes terabytes), of data.
Sync apps therefore don't try to sync them automatically to the local machine where storage might not be available to store all these files.
1. In the System Tray, right-click on the FileCloud Sync icon, and then select Settings.
2. On the Settings window, in the Other Settings section, click Edit.
3. Click the Network Folders tab, and then click the Add Network Folders button.
4. Select a network folder that can be downloaded locally for an offline copy.
28
When adding a network folder for offline access, you can choose to set the refresh schedule.
Schedule
Manual: Synchronizes this folder with the Network Folder only when the user selects the "Run Now" or the "Run Manual Tasks Now" option
Every 30 minutes
Every 1 hour
Every 2 hours
Every 4 hours
Every 8 hours
Every 24 hours
29
To enable this option, also make sure to enable remote deletion of files via offline sync in the admin settings for the network share. See below
30
31
Backing Up Files
In addition to syncing files automatically, you can also backup specific folders in your Windows, Mac or Linux Desktop to FileCloud for
safekeeping.
Folders selected for backup are automatically backed up on a schedule selected by the user.
32
Configure the Backup Schedule
Important Note: Backup must be allowed by the the administrator of your FileCloud to allow backing up your computer's files and folders. If your
administrator has disabled backup, you will not have the option to setup backup.
After selecting the folder you want to backup, no backup will occur until you do one of the following:
Leave the schedule setting to Manual and click the Run Now button
In the schedule setting, change Manual to an interval in the list
In the schedule setting, change Manual to Choose a different schedule, and then configure when the backup occurs.
When adding a backup folder, you can choose to set the backup schedule.
Schedule
Manual Backup runs only when user selects this backup folder and selects the
Run Now option
Every 30 mins After selecting your settings, the folder(s) will be backed up in 30 minutes
and continue backing up every 30 minutes.
Every hour After selecting your settings, the folder(s) will be backed up in 1 hour and
continue backing up in 1 hour intervals.
Every 2 hours After selecting your settings, the folder(s) will be backed up in 2 hours and
continue backing up in 2 hour intervals.
Every 4 hours After selecting your settings, the folder(s) will be backed up in 4 hours and
continue backing up in 4 hour intervals.
Every 8 hours After selecting your settings, the folder(s) will be backed up in 8 hours and
continue backing up in 8 hour intervals.
Every 24 hours After selecting your settings, the folder(s) will be backed up in 24 hours
and continue backing up in 24 hour intervals.
33
Choose a different schedule Opens a dialog box to create a custom schedule, where days of the week
and time can be selected.
If you choose to create your own schedule, you can select the Day and Time you want.
1. Launch FileCloud Sync by right-clicking on the icon in your system tray, and then select Settings.
2. In the Settings window, in Backup, click Edit.
3. To set a schedule, you must select a folder in the list.
4. To disable automatic backups and just back up the folder now, leave the schedule setting to Manual, and then click the Run Now button.
5. To choose a pre-set interval from the list, In the schedule setting, change Manual to an interval.
6. To create your own backup schedule, in the schedule setting, change Manual to Choose a different schedule.
7. If you chose to create your own schedule:
a. On the Offline Folder dialog box, to set the day, select one of the checkboxes.
b. Select the time of day by scrolling through the times.
c. Click Save Changes
8. Close the Backup Folders tab.
9. Close the Settings window.
34
Selecting Files to Backup
Important Note: Backup must be allowed by the the administrator of your FileCloud to allow backing up your computer's files and folders. If your
administrator has disabled backup, you will not have the option to setup backup.
To select which folders are backed up by the Sync app, you will need to configure your Settings.
5. Browse to the folder in the Sync path that you want to backup.
7. After selecting the folder, no automatic backup will occur until you do
one of the following:
Leave the schedule setting to Manual and click the Run Now button
In the schedule setting, change Manual to an interval in the list
In the schedule setting, change Manual to Choose a different
schedule, and then configure when the backup occurs.
35
36
Viewing and Restoring Backups
Viewing Backups
Files on your computer are backed up to your FileCloud "My Files" / backups folder.
You can view the backups folder by opening FileCloud in your web browser and opening your "My Files/backups" folder.
The backups folder shows a listing of all devices that are backing up to the FileCloud system. Clicking on each device will show backup folders being
backed up from that device.
Note that backup of files will count towards your total storage quota allocated to you in FileCloud.
Restore Backups
You can restore backups from the FileCloud server by downloading backed up files using the webportal, FileCloud Drive or WebDAV app.
37
XML Options for Sync
There are some advanced sync options to control the behavior of FileCloud Sync. Only use an option if you need its function since some of the options
are experimental.
For administrators: Most of these options are also available for ServerSync, and you can add them to the file %APPDATA%
\FileCloudServerSync\syncclientconfig.xml.
If an option is not available for ServerSync, it is indicated in the NOTES column in the table below.
To enable these options open the syncclientconfig.xml and add the following entries
Windows: %APPDATA%\FileCloudSync\syncclientconfig.xml
Mac OSX: {HomeDir}\FileCloudSync\syncclientconfig.xml
Linux: {HomeDir}\FileCloudSync\syncclientconfig.xml
OPTION NOTES
<rowentry> Allows you to specify the file types that should be ignored during Sync
<name>backuprestrictions</name> backup.
<type>string</type>
<value>mp3</value> Multiple values can be specified by using "|" - for example "mp3|bat"
</rowentry>
<rowentry> Allows you to specify the upload size limit during Sync backup.
<name>backupsizelimit</name>
<type>double</type> Must be specified in MB.
<value>2</value>
</rowentry> Not available for FileCloud ServerSync.
<rowentry> By default, on sync startup, it will check and report availability of a new
<name>checkupdates</name> version. Setting this option to 0 skips the version check.
<type>bool</type>
<value>0</value>
</rowentry>
<rowentry> By default, once a shared folder is removed at the remote server local
<name>removeunshared</name> shared folders are not removed.
<type>bool</type> Enabling this option will remove all folders if they are no longer being
<value>1</value> synced.
</rowentry> Use this option with caution as data loss might happen if the user had
added some files to those shared folders.
<rowentry> Uses file modification times additionally to detect file changes. Only
<name>checkmodtime</name> applicable when using My Files (Managed Storage).
<type>string</type>
<value>1</value> By default, only change in file sizes are used to detect changes to local
</rowentry> files. If you are changing some files where the file sizes do not change
(like XLS, XLSX) files, then the file size might not change with changing
the file under some cases. To detect these changes and upload to the
server, enable this option. After enabling this option, restart the sync app
and then select "More options" -> Reset all sync data. The app will prompt
you to re-login. Enter your account information to continue, once it resyncs
all the data then new file changes will be detected and synced
automatically.
<rowentry> Uses file CRCs additionally to detect file changes. Only applicable when
<name>checkcrc</name> using My Files (Managed Storage). Use only checkmodtime option above
<type>string</type> if possible as using CRCs increases CPU load when scanning for
<value>1</value> changes. It is also possible to combine CRC checks with modtime checks
</rowentry> for additional verification.
After enabling this option, restart the sync app and then select "More
options" -> Reset all sync data. The app will prompt you to re-login. Enter
your account information to continue, once it resyncs all the data then new
file changes will be detected and synced automatically.
38
</rowentry>
<name>skipdeleteapproval</name>
<type>bool</type>
<value>1</value>
</rowentry>
<rowentry> Determines what percent of removed files will trigger a confirmation before
<name>deleteapprovalpct</name> remote server delete.
<type>string</type>
<value>1</value> For example,
</rowentry>
0 will show alerts for all changes.
50 will show alerts only when at least 50% of files change.
<rowentry> Determines if strict ssl verification is used when connecting to servers over
<name>sslverify</name> HTTPS (SSL)
<type>string</type>
<value>VERIFY_NONE</value> VERIFY_STRICT - SSL Verification is enabled which is the default since
</rowentry> FC 15.0
<rowentry> If FileCloud sync client has to use a HTTP Proxy server for outside
<name>httpproxyhost</name> connections, use this parameter to configure proxy server address.
<type>string</type>
<value>10.1.0.1</value> For example, if your proxy server is 10.1.0.1, it can be configured as
</rowentry> shown.
<rowentry> If FileCloud sync client has to use a HTTP Proxy server for outside
<name>httpproxyport</name> connections, use this parameter to configure proxy server port.
<type>string</type>
<value>8080</value> For example, if your proxy server listens at port 8080, it can be configured
</rowentry> as shown.
<rowentry> If FileCloud sync client has to use a HTTP Proxy server for outside
<name>httpproxyuser</name> connections, use this parameter to configure proxy server user.
<type>string</type>
<value>proxyuser</value> For example, if your proxy server needs to authenticate with a user
</rowentry> proxyuser, it can be configured as shown.
<rowentry> If FileCloud sync client has to use a HTTP Proxy server for outside
<name>httpproxypassword</name> connections, use this parameter to configure proxy server user.
<type>string</type>
<value>passw0rd</value> For example, if your proxy server needs to authenticate with a password
</rowentry> passw0rd (for configured proxy user), it can be configured as shown.
39
<value>1</value> an alternative to the Disable Notifications setting in Settings > Other
</rowentry> Settings > Advanced, which disables all notifications.
<rowentry> When set to 1, if any files were skipped during syncing, displays a
notification message which says "Some files were ignored by Sync.
<name>disablenotifications</name> Please check Activity Log for details."
<type>bool</type>
<value>1</value>
</rowentry>
Yes, if you are working with XLS files (which don't change size when edited) you will need this option.
Most files today including XLSX, or DOCX etc always change file size when anything is changed.
Adding the checkmodtime or checkcrc results in additional CPU load as the sync app has to do more work to detect changes so this is not a
default option.
How can we avoid further data loss of local data after enabling "checkmodtime" or perhaps "checkcrc" and doing an "reset
all sync data"?
After enabling this option, sync will download everything from the server to ensure it has a clean slate. You should not have local modified files
in this case.
After it is fully synced, this will never happen again.
40
Internal Sync Options
OPTION NOTES
41
Sync Troubleshooting Guide
The FileCloud Sync client keeps all your local files exactly the same as what's on the FileCloud server.
Because of the wide variety of local computer environments as well as a variety of network and server configuration, there can be sometimes
issues when the synchronization occurs.
You can troubleshoot synchronization issues by understanding how sync works, and steps to resolve specific issues.
42
Files that don't sync
Under the following conditions, FileCloud sync client might be unable to sync files to or from your FileCloud installations.
Special Characters
FileCloud Sync doesn't sync some files with characters that are incompatible with some operating systems.
Rename them to something more suitable for use across multiple operating systems.
The * character
The < character
The > character
The : character
The \ character
The / character
The | character
The ? character
The * character
The ~ character
tonido.db
Thumbs.db
desktop.ini
Anything ending with .tmp
Anything ending with .lnk
Files or Folders ending with space
.tonidocache
Anything starting with Conflict_
sync.ico
.ds_store (starting with 4.71 version of Sync Client)
Any hidden files (usually files starting with . in Linux and files with hidden attribute in windows)
File names and file extensions which are restricted by the server admin
Files that are in use
Beginning in Version 19.1, FileCloud supports overriding file type restrictions. To allow users to sync file types such as lnk, ini and thumbs.db,
as well as hidden files, use the allowedfilelist option on page XML Options for Sync.
In 11.0, Sync did not synchronize files with ".." in the name. In 12.0, this restriction has been removed.
Sync only detects changes when the file size changes. If the file size does not change, then the file modification is not detected by sync.
43
Change Sync Folder Location
FileCloud Sync app stores synchronized files at a default location
Windows:C:\users\<user>\My Documents\FileCloud
Mac OSX: {HomeDir}\FileCloud
Linux: {HomeDir}\FileCloud
To change the sync folder, open "Settings" option and then click on the "Settings" tab.
Windows: %APPDATA%\FileCloudSync\syncclientconfig.xml
Mac OSX: {HomeDir}\syncclientconfig.xml
Linux: {HomeDir}\syncclientconfig.xml
Note
When you are trying to specify an UNC path in syncclientconfig.xml file, you must enter the path like this:
\\\\<URL or IP address>\<path>
Example:
\\\\10.0.0.1\<path>
1.
44
1. Stop the FileCloud Sync App
2. Change the syncclientconfig.xml file, and modify the "value" key of syncfolderlocation entry to the path you want (For example, if you want
synchronized files to store at H:\data <value>DEFAULT</value> to <value>H:\data</value>. WARNING: If you set incorrect paths, sync might not
work properly.
3. Make sure to copy all the files (if you had synced files earlier) from the old sync folder to the new location e.g. H:\data\FileCloud
4. Restart the Sync app
45
Changing FileCloud Sync Cache Folder
FileCloud Sync app stores temporary files in a cache folder.
Windows: %APPDATA%\FileCloudSyncData
Mac OSX: {HomeDir}\FileCloudSyncData
Linux: {HomeDir}\FileCloudSyncData
Windows: %APPDATA%\FileCloudSync\syncclientconfig.xml
Mac OSX: {HomeDir}\FileCloudSync\syncclientconfig.xml
Linux: {HomeDir}\FileCloudSync\syncclientconfig.xml
46
FileCloud Sync icon overlays not appearing
The registry entries (related to icons overlay) have been updated so that icon overlays are automatically seen and no manual changes need to
be made in FileCloud Server version 19.1 and later.
In Windows 10, Microsoft installs OneDrive icon overlays and makes other app overlays disappear. There is a limit of 8 or 9 max overlay handlers that can
work. For more info, please see
http://stackoverflow.com/questions/31964627/tortoisesvn-icons-overlay-not-showing-after-updating-to-windows-10
Remove the unneeded entries and restart and the sync icons should show back up.
The ones you need are OverlayExtension, OverlayExtensionConflict and OverlayExtensionModified
47
48
Sync Logs
If the FileCloud Sync client stops working, you might need to send Sync data logs to Technical support, so they can help address the issue.
To access log files, in your system tray, right-click the Sync icon and click Settings, and then click Help.
To get the most recent log file, click Save Log File.
To get all the log files, click on Open Sync Data Folder.
The folder where the synclient.log files are located opens. Sometimes there are multiple syncclient.log files numbered as syncclient.log.0,
syncclient.log.1 etc. You can copy them all to a zip file and send it via email to support.
To export the most current log to an xml file, click Export Config.
To import a log file from your file system, click Import Config.
49
Sync Engine Types
Real-time Synchronization
Real-time synchronization will synchronize files as they change locally and with minimum delay from the server. You can initiate a sync at any time
immediate using the "Sync Now" option. Real-time synchronization works for all files inside Managed Storage (My Files and Shared with Me) as well as for
network folders setup with Real-time sync (Which is in beta).
Periodic Synchronization
Periodic synchronization will synchronize files on a specified time interval starting at every 30 minutes, 1 hour etc. You can initiate a sync at any time
immediate using the "Sync Now" option. Periodic synchronization works for all files inside Network Folders. Backing up files from local computer to Remote
server is also a form of Periodic synchronization.
Local Change Upload Frequency Uploads local changes as soon as local file Uploads changes after specific interval
changes
Remote Change Download Frequency Default is every 2 minutes, can be changed by Downloads changes after specific interval
changing the Sync Frequency in More Options-
>Other Settings->Advanced Tab.
Type of Remote Storage Managed Storage (My Files and Shared with Network Folders and Local to Remote Backup
me) as well as Network Folders setup with
Realtime sync (Beta)
Initial Setup Folders under My Files and Shared Folders with User manually chooses folders to download and
"Sync" permissions are automatically sync
downloaded
Limits Managed Files (No limit, tested up to 300,000 Efficient up to 500-1000 folders. The more
files), Network Folders with Realtime sync number of folders, the longer it takes to
(50,000 Files) synchronize.
50
View Sync Error Details
From Settings
2. From the system tray, right-click the FileCloud icon and then select Settings.
3. On the Home page, next to Recent Errors, click View.
2. From the system tray, right-click the FileCloud icon and then select Settings.
3. On the Home page, select the Help screen option.
4. To save a log file with the most current data, under Troubleshooting, click Save Log File, note the folder location, and click OK.
5. To open the log for searching, open Windows Explorer, and navigate to the directory where you saved the file. The file name will use a format
similar to Exported_synclient_2018-12-28-11-17-14.
6. Open the file and search for errors in the log.
51
Sync Errors and Issues
Because of the wide variety of local computer environments as well as a variety of network and server configuration, there can be sometimes
issues when the synchronization occurs.
This can also make troubleshooting complicated. Use the following topics to find steps that will help you troubleshoot and resolve issues.
General Strategies
Specific Issues
Click an issue in the following list to read more about it.
Cause
The shared folder must have permissions set in order for you to sync with it.
Resolution
Sharing Folders
Cause
Resolution
Verify the files on the server that you are trying to sync are not locked.
Cause
When starting up for the first time on a new computer, Sync will:
If there is a large number of files and data on the FileCloud server, this initial sync will take a long time to download the files.
Resolution
In Sync, click the Home tab to see the Status. It indicates the current syncing status. If syncing is enabled, it displays ON. Sync Settings
In Sync, click the Home tab, then click View Errors to see if there are any reported errors. If there are errors, please follow the steps
mentioned below depending upon the error.
52
Cause
After downloading files, Sync finds an inconsistency with the downloaded file from the server. This could be due to several factors:
Resolution
Download the same file via the web browser and see if it downloads correctly.
Note the size of the file. Does the size match the size displayed in the web browser listing?
If matches then it could be a transient network condition. Retry to sync the files again.
If the file size doesn't match then there is something wrong with the storage. Please contact FileCloud support.
Cause
Resolution
Try uploading the same file to the exact same location using the web browser
If the upload fails, then note the error.
The problem could be the location you are trying to upload has no permissions or there could be a server configuration or
environment issue.
Check with the administrator to see if the server has sufficient disk space in the drive FileCloud is installed on.
If you are storing files on a network path, make sure the network path is available and that FileCloud server can write to the network
share.
Check the file name for any special characters that could make the upload fail.
If this is the issue, try renaming the file and see if the upload works.
Cause
Resolution
Check if the Windows Explorer integration was installed and the PC was rebooted
Check the troubleshooting options shown here.
Cause
FileCloud restricts the use of certain special characters in file names. If a file contains one of these characters they do not get synchronized.
..
\
/
:
*
?
"
<
>
|
FileCloud allows an administrator to restrict certain types of files for security reasons.
Resolution
Check the full list of special characters that don't get synchronized.
Check if the file has an extension that is disallowed for sync by server.
For example by default, PHP, PHP5 file extensions don't get synced.
You can change the allowed file types on the server and restart the sync
Cause
53
If you try to share a folder that contains other folders already being shared, Sync might continuously try to sync those folders.
For example:
Resolution
Check if to see if there are two shares that are setup inside one folder with sync permissions.
You only need to sync the top-level folder to get the subfolder synchronized.
Cause
Sync uses file sizes to detect file changes and then upload them. Some file formats like XLS don't change the file size when content is changed so
these files might not be uploaded.
Resolution
Cause
Finder includes Files and Folders in the total list of items. So that number will be different from the number of files reported in sync.
Also .DS_Store files are not synced by sync app, so those files will not be synced.
Finally, the size reported by Finder uses a different way of calculating GB size vs FileCloud.
Filecloud Sync does not show an error every time a user copies and then pastes a file or folder into the parent folder. In FileCloud Drive, the same
action displays an error that the parent folder is Read-Only. The user can be confused when no error is shown in FileCloud Sync but is shown in Drive.
Cause: In FileCloud Sync, these errors are shown only every 3 hours.
The user will see the following message: Skipping top level files or folders that are not inside a sync-able folder
The message is displayed in the Activity log and also as a pop-up notification
Only the name of the very first folder or file that cannot be synchronized is displayed in the Activity log and pop-up (Instead of every file and
folder name)
54
Managing Files in File Explorer
The remote file browser functionality is available in FileCloud Server version 13.0 and later.
The ability to access details and metadata for a file directly in Sync is available in FileCloud Server version 18.2 and later.
You can use FileCloud Sync synchronize your files with the FileCloud Server.
Windows Explorer
Mac OSX Finder
The only difference is that the files you are working on are stored in a remote location (the FileCloud Server) and not on your local disk.
Sync is an alternative to using a web browser to access files stored on the FileCloud Server.
What do you want to do?
Browse my files
Download a File
Upload a File
Troubleshooting
55
View or Clear Log Messages
56
Sharing Files in Sync
File sharing allows you to provide public or private access to files stored in FileCloud Server and saved in your Sync folders with various levels of
access privileges.
While files can easily be shared simply by emailing someone your file, sharing files using Sync allows you to:
Requires a FileCloud Set Permissions Set Options Share with Everyone Share with a Specific
Account User
Notifications
Require Password
Private Invite those without View Share Name Add Groups to share With a FileCloud
account
an account to create one Download Expiration with multiple us users at
once
Share Notifications
To create a share or manage it, you will always select the Share option from the right-click menu.
Even if the file is already being shared, to access the Manage Share window you must select the Share option again.
The Manage Share window contains buttons to perform the following actions:
The Manage Share window also contains two panels for configuring access.
57
Set Restrictions on Downloads
58
Sync Restrict Download Options
Note
By doing this, your file is restricted to download only a certain number of times.
59
Sharing Files Publicly in Sync
You can share a file so that anyone can access the file even if they don't have a FileCloud account.
If you want more security but still want a large number of people to access the file, you can enable password protection.
For additional security, and if you only want a small number of people to access the file, you can choose to share the file privately.
60
Sharing Files Publicly with An Expiration Date in Sync
You can share a file with any user, even one without a FileCloud account, and then for security reasons you can limit the time the share is
available.
To set an expiration date when you share a file, you can leave most of the default settings as-is.
Expires to Expires
This disables the use of the URL to the shared file after the selected date.
1. In the system tray, right-click the FileCloud Sync icon ( ) and select File Browser.
2. In the File Browser window, right-click the file and then select Share.
3. On the Share link pop-up window, click Advanced Options.
4. On the Manage Share for file window, in Share Options, select Expires.
5. A date appears underneath the radio button. Click the calendar icon to select an expiration date.
6. In Restrict Downloads, leave the default of No Restrictions or select Restrict to and set a restriction.
7. In Email File Change Notifications, leave the default of YES or to turn them off select NO.
8. In Enable Password Protection, you can leave the default of NO or select YES.
9. A randomly-generated password is shown. You can use this or change it to another secure password.
10. On the Manage Share for file window, in Share Permissions, leave the default of Allow Everyone.
11. To save your changes, click Update.
61
Sync Public Share Options for Files
When you share a file publicly, you can configure any restrictions and specify which users have access.
You first create the Share using Advanced Options - after you right-click a file in the File Browser window and select Share, this button is
available on the pop-up window with the Share link
After you create the share using Manage Share - after you right-click a file that is already being shared in the File Browser window, and select
then Share again, the Manage Share window opens
To create a share or manage it, you will always select the Share option from the right-click menu. Even if the file is already being shared, to access the Man
age Share window you must select the Share option again.
The Manage Share window contains buttons to perform the following actions:
The Manage Share window also contains two panels for configuring access.
62
What Do You Want to Do?
Click on a topic to expand it.
In the Manage Share for file window, you can set the following SHARED OPTIONS:
Share File/Folder current location of the file Although you can type in this field and click
Update, you cannot change the folder path
here.
Restrict Downloads
No Restrictions No Restrictions - allows any user to
Restricted mode download a file an unlimited number of
times. This is the default setting.
Restricted mode - allows any users to
download a file a limited number of times.
1. In the system tray, right-click the FileCloud Sync icon ( ) and select File Browser.
2. In the File Browser window, right-click the file and then select Share.
3. On the Share link pop-up window, click Advanced Options.
4. On the Manage Share for file window, in Share Options, to set a date when you want to stop sharing the file, select Expires and then either
select a date using the calendar icon or type in a future date.
5. If you want to restrict the number of times a file can be downloaded, select Restrict To and then type in a number greater than 0.
6. To disable sending an email notification when a file is opened or downloaded, in Email File Change Notifications, select No.
7. To require a user to enter a password before accessing the file, in Enable Password Protection, select YES. You can either use the randomly
generated password or type in one of your own.
8. To save your changes, click Update.
In the Manage Share window, you can configure who can access the file in the SHARE PERMISSIONS panel.
For public sharing, select Allow Everyone. If you want more security, you can use the SHARE OPTIONS panel to set a password.
1.
63
1. In the system tray, right-click the FileCloud Sync icon ( ) and select File Browser.
2. In the File Browser window, right-click the file and then select Share.
3. On the Share link pop-up window, click Advanced Options.
4. On the Manage Share for file window, in the Share Permissions panel, select Allow Everyone.
5. To require a user to enter a password before accessing the file, in the Share Options panel, in Enable Password Protection, select YES.
6. You can either use the randomly generated password or type in one of your own.
7. To save your changes, click Update.
64
Sync Set Share Preview For Public Folder Shares
The ability to select a file as the default preview when sharing a folder in public mode is available in FileCloud version 14.0 and later.
This will cause a persistent preview while share recipient browses the share.
4. In the additional settings dialog, select a preview file by using the file chooser dialog.
5. Once the preview file is selected, click on 'Save' button to save the selection.
Note
The preview file can be only within the shared folder. It cannot be a file from outside this folder tree.
65
Viewing share with preview
The share with preview is to be viewed similar to a regular public share. Opening the share link from a browser will display the share contents with the
preview of the selected file appearing on the right panel.
66
Sync Sharing Files Publicly with Everyone
That means when you share a file, you can leave the default settings as:
SHARE OPTIONS
Restrict Downloads No Restrictions This allows you to specify the number of times
this file can be downloaded
Email File Change Notifications YES This sends an email notification when a file is
opened or downloaded for a public share
Enable Password Protection NO This allows a user to access a file without first
providing a password
SHARE PERMISSIONS
1. In the system tray, right-click the FileCloud Sync icon ( ) and select File Browser.
2. In the File Browser window, right-click the file and then select Share.
3. On the Share link pop-up window, click Advanced Options.
4. On the Manage Share for file window, in Share Options, leave the default of Never Expires.
5. In Restrict Downloads, leave the default of No Restrictions or select Restrict to and set a restriction.
6. In Email File Change Notifications, leave the default of YES or to turn them off select NO.
7. In Enable Password Protection, leave the default of NO. If you want, you can enable this and set a password.
8. On the Manage Share for file window, in Share Permissions, leave the default of Allow Everyone.
9. To save your changes, click Update.
67
Sync Sharing Files Publicly with Password
The ability to share publicly but still require a password to access the share is available in FileCloud Server version 13.0 and later.
You can share a file with any user, even one without a FileCloud account, by giving them the link. For additional security you can require a
password.
This option is not available for sharing a file privately with a user who already has a FileCloud account.
To require a password when you share a file, you can leave most of the default settings as-is.
NOTES:
68
To share a file with everyone without restrictions:
1. In the system tray, right-click the FileCloud Sync icon ( ) and select File Browser.
2. In the File Browser window, right-click the file and then select Share.
3. On the Share link pop-up window, click Advanced Options.
4. On the Manage Share for file window, in Share Options, leave the default of Never Expires.
5. In Restrict Downloads, leave the default of No Restrictions or select Restrict to and set a restriction.
6. In Email File Change Notifications, leave the default of YES or to turn them off select NO.
7. In Enable Password Protection, select YES.
8. A randomly-generated password is shown. You can use this or change it to another secure password.
9. On the Manage Share for file window, in Share Permissions, leave the default of Allow Everyone.
10. To save your changes, click Update.
69
Sync Sharing Files Privately
You can share a file only with users who have a FileCloud account.
70
Sync Private Share Permission Options for Files
Private Sharing means you are only allowing users with a FileCloud account to access your file.
On the Manage Share window, in the SHARE PERMISSIONS panel, when you choose
You will be able to lookup users and groups who have a FileCloud account, add them as a Guest, and then send them an email with the link.
For each guest that you add, you can assign the permissions as shown in Table 1.
Permission Description
View Read access will allow users to view, browse or download files,
Removing view access will remove the user from the share completely.
Share Share access will allow users to re-share files or folders with other users
of their choosing.
Sharing access can be provided only if View and Upload access are
already provided.
71
Sync Sharing Files Privately with Existing Users
You can share a file with a user who has a FileCloud account.
Private Sharing means you are only allowing users with a FileCloud account to access your file.
You can add Users and Groups.
You will be able to lookup email addresses, add them as a Guest, and then send them an email with the link.
That means when you privately share a file, you can leave the default settings in:
SHARE OPTIONS
SHARE PERMISSIONS
Allow Selected Users/Groups = selected. This allows you to specify which FileCloud users and groups can access the file and their permissions,
as shown in Table 1.
Permission Description
Allow View Read access will allow users to view, browse or download files,
Removing view access will remove the user from the share completely.
Allow Download This will allow the user to save the file
Allow Share
Allows the user to share your file with other users.
Sharing access can be provided only if View and Upload access are
already provided.
1. Access FileCloud Sync options by right-clicking on the icon in your system tray
2. To open a file explorer window, selecting File Browser.
3. A File Browser window opens, displaying the contents synchronized with FileCloud Server.
4. Right-click the file you want to share, and then select Share.
5. In the Share Link dialog box, click Advanced Options.
6. On the Manage Share dialog box, in Share Permissions, select Allow Selected Users/Groups.
7. To add a FileCloud user, select the Guest tab, and then click Add Guest.
8. In the Search Users dialog box, type in the user's account or email address, and then click Search.
9. Select the user who you want to share with.
10. In the Share Notification Email dialog, you can edit the contents of the email and then click Send, or to not send the email, click Cancel.
11. On the Manage Share dialog box, in Share Permissions, select the guest you just added.
12. To set permissions, check any of the following options: Allow View, Allow Download, Allow Share.
13. To save your changes, click Update.
72
Sync Sharing Files Privately with New Users
You can share a file with a user who does not have a FileCloud account yet but wants one.
Before you can invite a new user to create a FileCloud account, an administrator must configure the FileCloud site to allow it.
If you are not able to invite a new user to access your share, contact your administrator about allowing new user account creation.
If you are an administrator, follow these instructions to allow new users to create an account.
You are only allowing users with a FileCloud account to access your file.
When you invite a new user to share your files, the following process occurs:
1. You share a file and invite a new user to create a FileCloud account.
2. You need to know their email address, add them as a Guest, and then send them an email with the link to create an account.
3. The user you have invited uses the link to create their own FileCloud account.
4. After the new user signs in, they have a Full Access FileCloud account.
5. The new user can access the file.
An account with Full Access has its own private cloud storage space in the "My Files" area.
That means when you privately share a file, you can leave the default settings in:
SHARE OPTIONS
SHARE PERMISSIONS
Allow Selected Users/Groups = selected. This allows you to specify who you want to invite to create a FileCloud account so that they can access
the file.
73
To share a file with a new FileCloud user:
1. Access FileCloud Sync options by right-clicking on the icon in your system tray
2. To open a file explorer window, selecting File Browser.
3. A File Browser window opens, displaying the contents synchronized with FileCloud Server.
4. Right-click the file you want to share, and then select Share.
5. In the Share Link dialog box, click Advanced Options.
6. On the Manage Share dialog box, in Share Permissions, select Allow Selected Users/Groups.
7. To invite a new user, select the Guest tab, and then click Add Guest.
8. In the Search Users dialog box, type in the user's email address, and then click Search.
9. You will see a message telling you no user was found.
10. In the Search dialog box, click Invite.
11. In the Share Notification Email dialog, you can edit the contents of the email and then click Send.
12. You will see a message about the Email Status. read it and then click Close.
13. On the Manage Share dialog box, in Share Permissions, select the guest you just added.
14. To set permissions, check any of the following options: Allow View, Allow Download, Allow Share.
15. To save your changes, click Update.
74
Browse My Sync Files
The remote file browser functionality is available in FileCloud Server version 13.0 and later.
The ability to access details and metadata for a file directly in Sync is available in FileCloud Server version 18.2 and later.
Windows Explorer
Mac OSX Finder
Sync is an alternative to using a web browser to access files stored on the FileCloud Server.
In the Sync client, the files you are working on are stored in a remote location (the FileCloud Server) and not on your local disk.
To open Sync:
1. Access FileCloud Sync options by right-clicking on the icon in your system tray
2. To open a file explorer window, selecting File Browser.
3. A File Browser window opens, displaying the contents synchronized with FileCloud Server.
You can navigate to different locations in the remote FileCloud server by different methods.
Using the left hand side folder tree to navigate to different folders
75
Double-clicking folders on the right hand side folder listing
By entering the full path in the path entry text area and then pressing enter
You can also navigate to older locations that you previously visited by using the History back and forward arrows.
In any file listing, select the Refresh Icon or hit 'F5' to refresh the file listing.
76
Viewing Favorites
Quickly navigate to different folders or files saved in favorites by using the Favorites menu.
77
Create a Direct FileCloud Link in Sync
You can use this option to create a link to an item to share with others, but they must already part of the share.
Therefore, this Direct Link option works only with items in the following folders:
Shared with me
Team Folders
Clicking the share will require that the user log in to FileCloud Server and then they are taken directly to the selected folder or file.
1. Launch FileCloud Sync by right-clicking on the icon in your system tray, and then selecting File Browser.
2. A File Browser window opens, displaying the contents synchronized with FileCloud Server.
3. Open the Team Folder or Shared with Me folder, right-click the item you want to share, and then select Create Direct FileCloud Link.
4. A Share Link window opens to provide the link.
5. To set permissions and other share options, click Advanced, and then set Public Share Options for Files.
6. A window opens that displays the email message which will be sent to the user who you are sharing with. You can choose to edit the contents of
the email or choose not to send the email.
7. To close the email notification window, click Send or Cancel.
78
Create a New Folder in Sync
You can create a new folder in Sync that will be automatically synchronized with the FileCloud Server.
Select the Create Folder icon to create a new folder in the current location.
Select items you want to copy and choose the Edit menu and select the 'Copy' option.
Navigate to another path and again choose the Edit menu and select the 'Paste' option.
79
Delete Files and Folders in Sync
1. Select items you want to delete and choose the Edit menu and select the 'Delete' option.
Alternatively, right click on the file or folder and bring up the context menu and choose 'Delete'.
80
Download a File in Sync
You can download a folder or open a file for editing by viewing the file in the FileCloud site.
Downloading an item creates a local copy that will be synchronized with the copy on the FileCloud site.
In Microsoft Windows, it is also possible to drag a file directly to another location like your desktop or another location in the Windows File
Explorer.
1. To launch FileCloud Sync, right-click the icon in your System Tray, and then select File Browser.
2. A File Browser window opens, displaying the items synchronized with FileCloud Server.
3. Right-click the item you want to view, and then select View in FileCloud Site.
4. In the User Portal, click the file you want to download, and then click Download.
5. Select the local folder where you want to save the file.
You can clear the pending upload or download queue from the View menu. Select the Clear Queue option.
81
Edit a Sync File
You can quickly open a file for editing from the Sync folder.
To edit a file:
1. Launch FileCloud Sync by right-clicking on the icon in your system tray, and then selecting File Browser.
2. A File Browser window opens, displaying the contents synchronized with FileCloud Server.
3. Double-click a file to open the file for editing.
4. Make changes and then click Save.
5. Your changes will get uploaded to the server automatically.
82
Lock and Unlock Folders in Sync
You can set a lock to prevent other users from opening a folder.
Locking tells other users that you are actively using that folder.
The owner of the lock has full access to that folder and can modify it
An Admin can always override a lock
Users cannot download the locked folder
Users cannot view the locked folder
Users cannot modify the locked folder
When you lock a folder, all of the following clients will be subject to the lock restrictions:
To lock a folder:
1. Launch FileCloud Sync by right-clicking on the icon in your system tray, and then selecting File Browser.
2. A File Browser window opens, displaying the contents synchronized with FileCloud Server.
3. Right-click the item you want to lock, and then select Lock FileCloud Folder.
To unlock a folder:
1. Launch FileCloud Sync by right-clicking on the icon in your system tray, and then selecting File Browser.
2. A File Browser window opens, displaying the contents synchronized with FileCloud Server.
3. Right-click the item you want to lock, and then select Unlock FileCloud Folder.
83
Move Files and Folders in Sync
1. Select items you want to move and choose the Edit menu and select the 'Move option.
2. Navigate to another path and again choose the Edit menu and select the 'Paste' option.
84
Rename Files and Folders in Sync
1. Select item you want to rename and choose the Edit menu and select the 'Rename' option.
2. Choose the new name you want and hit "enter" or the "OK" button.
85
Search in Sync for a Folder
If you aren't finding something in File Explorer, you can easily jump to the FileCloud site to search.
Selecting the Search FileCloud Site option opens a search dialog with the chosen folder as the search path.
Files and sub-folders with the given name or pattern can be searched for in the path.
Advanced search options is provided to modify the search criteria. These options can be used to limit the search results, as required.
Similar to the right-click context menu on a folder, Search option is also available in the File Browser menu.
1. Launch FileCloud Sync by right-clicking on the icon in your system tray, and then selecting File Browser.
2. A File Browser window opens, displaying the contents synchronized with FileCloud Server.
3. Right-click the folder you want to search in, and then select Search FileCloud Site.
4. In the Search window, type in your search pattern.
86
Share a FileCloud Link in Sync
When you select the option to share a FileCloud link, a Manage Share window opens that provides access to the link.
You can access the options for sharing either by opening the file browser or using the right-click options inside the Sync folder.
1. Launch FileCloud Sync by right-clicking on the icon in your system tray, and then selecting File Browser.
2. A File Browser window opens, displaying the contents synchronized with FileCloud Server.
3. Right-click the item you want to share, and select Share FileCloud Link.
4. To copy the URL to your clipboard, click Copy URL.
5. To set permissions and other share options, click Advanced, and then set Public Share Options.
6. Use the URL you copied to share your item.
87
Upload a File in Sync
You can drag and drop files or folders into the right hand side folder listing to upload the files directly to FileCloud.
You can also use the following icons located in the top bar to upload a file or upload a folder.
Clear the pending upload or download queue items by selecting the "View" menu and selecting the "Clear Queue' option.
88
View or Clear Log Messages in Sync
You can view log messages to troubleshoot Sync issues, or clear the log if the file is getting too large.
1. Launch FileCloud Sync by right-clicking on the icon in your system tray, and then selecting Settings.
2. In the Settings window, click Activity.
1. Launch FileCloud Sync by right-clicking on the icon in your system tray, and then selecting Settings.
2.
89
2. In the Settings window, click Activity.
3. On the Activity screen, click Clear.
90
Work with Comments in Sync
You can add comments to a file, or see version information by viewing the properties.
To view properties:
1. Launch FileCloud Sync by right-clicking on the icon in your system tray, and then selecting File Browser.
2. A File Browser window opens, displaying the contents synchronized with FileCloud Server.
3. Right-click the item you want to view the properties for, and then select View FileCloud Properties.
4. Use the following instructions to manage File or Folder Comments.
91
Work with Metadata in Sync
You can view the metadata attributes for a file, or add an attribute if your administrator allows it.
1. Launch FileCloud Sync by right-clicking on the icon in your system tray, and then selecting File Browser.
2. A File Browser window opens, displaying the contents synchronized with FileCloud Server.
3. Right-click the item you want to view the properties for, and then select View FileCloud Properties.
4. Use the following instructions to manage metadata.
92
Synchronizing Files
You can use FileCloud Sync to keep a folder on any computer that is synchronized with your FileCloud server.
You can access files in Sync like you do on a Windows PC in Windows Explorer or Mac OSX Finder.
You can configure Network Folders to be automatically synchronized to your client.
You can back up Sync files for safekeeping
Sync Settings
Learn about Sync Options
Sync Icon Overlays and Extensions
Troubleshooting
93
Limit Sync Bandwidth Rate
The ability to limit the amount of bandwidth Sync can use and therefore reduce the impact on the network is available in FileCloud version 18.2
and later.
If you are running the FileCloud Sync app on a slow network, when Sync transfers files it can quickly use up all the network bandwidth.
You can limit the max amount of bandwidth that Sync can use to reduce the impact on your network and day to day operations
Bandwidth is specified in kilobytes (KiB/s)
You can set a limit to be used whenever you are running Sync
You can set a limit that is enforced only during a specific interval of time
You can set a different rate limit for uploading than you set for downloading files
If the available bandwidth is less than the specified maximum, then file transfer will still be limited to the available bandwidth
Sync maintains the file transfer bandwidth limits even when there are multiple simultaneous uploads or downloads
If you do not specify a bandwidth limit or if it is set to -1, then Sync will use all of the available bandwidth.
1. In the System Tray, right-click on the FileCloud Sync icon, and then select Settings.
2. On the Settings window, in the Other Settings section, click Edit.
3. Select the Advanced tab, and then next to Enable Bandwidth Rate Control, click Edit Settings.
4. To set a limit to be used whenever you are running Sync, on the Bandwidth screen, in Global Rate Limits, select the Upload and Download
checkboxes.
5. In the Global Rate Limits KiB/s fields, type or use the arrows to specify your limits for Upload and Download.
You can set different rate limits for uploading and downloading files.
6. To set a limit that is enforced only during a specific interval, on the Bandwidth screen, in Alternative Rate Limits, select the Upload and Download
checkboxes.
7. In the Alternative Rate Limits KiB/s fields, type or use the arrows to specify your limits for Upload and Download.
8. If you set Alternative Rate Limits, you must also specify a schedule in the From, To, and When fields.
9. Click Save Changes.
94
When one or more Bandwidth rate limits are set, the following message is displayed on the Home screen:
95
Limit Sync To a Schedule
The ability to limit the time when Sync is active is available in FileCloud version 18.2 and later.
You can set a schedule for the times when you want the Sync application to run.
For example:
If you are running the FileCloud Sync app on a busy network, you may want Sync to run at the least busiest times
If you just want to save your changes to the FileCloud Server at the end of each day
You can only set one time when Sync will run for every day you select. The default time is from 8:00:00 AM To 8:00:00 PM.
For example:
The settings you use impact the Sync application in the following ways:
Time Active Controls enabled Sync will be active ONLY during the To use the Start or Pause buttons again:
schedule times
Disable Time Active Controls
At all other times Sync remains
disabled, which means real-time
syncing and offline folders syncing
will be disabled.
The Start button on the Sync
Settings screen is disabled
The Pause button on the Sync
Settings screen is disabled
Time Active Controls disabled Sync will always be active If Time Active Controls are
automatically disabled, you can enable
them again by:
The Start button on the Sync Settings Unselecting the Doc editing only
screen can be used mode checkbox
96
Starts Sync by clicking the "Start"
button on Home screen
The Pause button on the Sync Settings
screen can be used
Doc editing only enabled This mode always takes precedence To use Time Active Controls again:
over Time Active Controls
Unselect the Doc editing only
If you enable Time Active Controls and mode checkbox
then choose the Doc editing only mode,
Time Active Controls will be
automatically disabled
1. In the System Tray, right-click on the FileCloud Sync icon, and then select Settings.
2. On the Settings window, in the Account Settings section, click Edit.
3. Under Options, you will find the Document editing only (no Sync) checkbox.
97
To set a schedule for Sync times:
1. In the System Tray, right-click on the FileCloud Sync icon, and then select Settings.
2. On the Settings window, in the Other Settings section, click Edit.
3. Select the Advanced tab, in Other Settings, click Edit Settings.
4. To set which days you want to run Sync, select the appropriate checkboxes.
5. You can only set one time when Sync will run for every day you select. Use the From, and To fields to specify a time.
6. Click Save Changes.
98
Managing Sync Conflicts
If two people change the same file at the same time, FileCloud Sync app won't try to merge the changes.
Conflict files are named as follows, where filename is the name of the file with the conflict, and the date is the date and time of the
conflict:
For a file in a shared folder, where other is the name of the other user who modified the file: filername(Conflict_other (Web
browser)_2020-03-25-22-50-36).txt
For a file in a team folder, where teamname is the team folder account name: filename(Conflict_teamname (Web browser)
_2020-03-25-23-01-42).txt
For a read-only file in a local sync folder,: filename(Conflict_Read-Only_2020-04-27-21-35-33).doc
You will see a conflict file in your browser's file listing You will also see a notification in the System Tray
By creating a second file, FileCloud Sync ensures that all changes are preserved and one person's changes will not overwrite another person's work.
When two persons save the same file at approximately the same time. In this case the first person's changes are saved to the server and
when the second person's sync app tries to save the file, it realizes there is a new version and will prevent the second person's changes from
uploading and overwriting the first person's changes. In this case the first person's file is downloaded instead and saved locally adjacent to
the original file with the "Conflict_" appended to it.
While one person was editing a file offline, the file was modified by another user. When the person who was offline comes back online and
the sync app tries to upload the edited version to the server, it will detect that there is a new version available and instead of overwriting the
changes on the server, it will download the server file locally and mark it as a "Conflict" file.
1. In the System Tray, right-click on the FileCloud Sync icon, and then
select Settings.
99
2. At the top of the Settings window, select Activity.
4. In the list of recent errors, find the file conflict that you want to resolve.
5. Double click the entry to open up a dialog that will help resolve the
conflict.
You can resolve the conflict by deleting the file that you don't want any
more.
For example, if you want to use the file in the server and discard local
changes, then:
100
Reviewing Skipped Files
The Sync client is used to ensure that computer files on FileCloud Server are copied to your local computer, and changes you make on your local
computer are uploaded back to the server.
When synchronization occurs, some file types in the local Sync folder are not processed by the Sync client application because they are on the list of
ignored files.
Files of this type are not uploaded from your local computer to the server.
The following types of files are currently being ignored by the Sync client application:
Description Notes
Files in use These are files that have an exclusive write lock or are read-only
File names matching the skip regex string This is configured in a file, usually by your administrator
File name extensions which are restricted by the server This is configured by your administrator
1. In the System Tray, right-click on the FileCloud Sync icon, and then
select Settings.
101
When the results are displayed, you can export the list.
You can also see the list of skipped folders on the following screens in Sync Settings:
102
To see Network Folders Stats: To see Backup Folders Stats:
1. In the System Tray, right-click on the FileCloud Sync icon, and then 1. In the System Tray, right-click on the FileCloud Sync icon, and then
select Settings. select Settings.
2. On the Settings screen, next to Network Folders, click Edit. 2. On the Settings screen, next to Backup Folders, click Edit.
103
Run Sync App as a Service
Starting with 12.0, it is possible to run the sync app as a Windows Service.
9. Start the sync app normally using the Services Control Panel applet.
sc delete cloudsync
104
Selective Folder Sync
Limiting what gets Synced
You can choose to limit what gets synced to a particular computer via the FileCloud sync app. This is useful when you have terabytes of data in an account
and you only want a few gigabytes of folders locally to conserve space.
To limit folders that gets synced, click on Settings in the Sync Applications Menu,
Then either
Click on "Select" link to select what gets synced in "My Files / Team / Shared Folders".
105
Click on Settings tab and select "Selective Sync" option
In the Selective Folder Sync Dialog, select the checkbox "Only folders below will sync to this computer" and then select the folders you want to
sync.
106
Click on "Only folders below will sync to this computer".
Then click on "Add Folder" to select folders you want synced. You can click on "Remove Folder" to remove any folders that were previously selected.
107
Note that when you switch from syncing all files to only specific files, any existing files in your sync folder will not be removed automatically. You
will have to remove them manually. This is to prevent accidental deletion of any user files.
When a user tries to make any changes, the following message will be displayed - "Centralized Configuration is being applied. Settings cannot be
changed. Please contact your administrator for assistance."
108
Sync for Netgear ReadyNAS
A command line version of the sync app is provided for Netgear ReadyNAS series of Network Attached Storage devices. Currently only x86-64 versions
running ReadyNAS OS 6.0 and above are supported. (ReadyNAS 312 for example is known to work)
Installation
Download the regular Linux x86-64 package and unzip the contents to any location on your NAS.
Configuration
In the unzipped folder, create an xml file called syncconconfig.xml and enter the credentials to the filecloud server to which to sync to.
109
<type>string</type>
<value>http://files.company.com</value>
</rowentry>
<rowentry>
<name>account</name>
<type>string</type>
<value>john</value>
</rowentry>
<rowentry>
<name>password</name>
<type>string</type>
<value>password123</value>
</rowentry>
<rowentry>
<name>limitfolders</name>
<type>string</type>
<value>/john/folder1|/john/folder2|/john/folder3</value>
</rowentry>
<rowentry>
<name>offline_folder_count</name>
<type>int</type>
<value>2</value>
</rowentry>
<rowentry>
<name>offline_folder_1</name>
<type>string</type>
<value>C:\data\local|/john/folder1|0|1h|1|0</value>
</rowentry>
<rowentry>
<name>offline_folder_2</name>
<type>string</type>
<value>C:\data\local2|/john/folder2|1|30m|1|0</value>
</rowentry>
</variantrow>
Also, adjust the contents of the xml file called syncclientconfig.xml and adjust the paths to whatever that you need.
Value Notes
syncfolderlocation This location is where the sync folder is created. Any files added or
modified here are synced back to the filecloud server.
syncclientlocation This location is where sync stores temporary files as well as all the sync
state information. It is recommended to delete the folder to reset the state
or when changing to a different sync server.
loglevel This value affects the amount of logging performed by the sync client.
'trace' is the default and allows full logging
110
<name>syncclientlocation</name>
<type>string</type>
<value>/root/FileCloudSyncData</value>
</rowentry>
<rowentry>
<name>syncfolderlocation</name>
<type>string</type>
<value>/root/FileCloud</value>
</rowentry>
</variantrow>
Startup
Create a startup script to startup the sync app and save it to a file called filecloudsyncconstart.sh
#!/bin/sh -e
export LD_LIBRARY_PATH=.
./filecloudsynccon 2> /dev/null 1>&2
chmod +x ./filecloudsyncconstart.sh
./filecloudsyncconstart.sh
111
Sync Icon Overlays and Extensions
Icon Overlays
FileCloud Sync app on Windows shows overlays over each file indicating the sync status of the file.
Overlay will be shown for all files and folders inside MyFiles, Network Shares and Shared with Me.
Icon Status
No Icon File or Folder is new and has not been synced to the sync server
File has been modified and has not yet been synced to the server
File is in conflict because changes have been made in both server and
local. It needs to be resolved by the user.
File is in lock state and owner has to release for any updates.
112
For Files and Folders inside the FileCloud Sync Folder
When you right click on a file or folder inside the FileCloud Sync folder two additional options are presented.
113
Option Description
Share FileCloud Link Selecting a file or folder and choosing this option will create a share for
this file or folder on the filecloud server and provide you with a URL to
share with. The URL will be copied directly to the clipboard and will be
ready for pasting.
View in FileCloud Website Selecting a file or folder and choosing this option will open the web
browser and browse to that folder location to allow easy operations via the
web browser.
Lock Folder/File Locks a Folder or File so that no others can modify the files when you are
editing them. Useful when multiple people are working on the same set of
files or folders.
Unlock Folder/File Unlocks a Folder or File so that others can modify them.
114
Mac OSX Finder Right Click Extension
To get right-click sharing options with FileCloud Sync on Mac OSX, you would need to install a workflow file. Find below the instructions to install the right
click action.
115
Syncing Team Folder Permission Changes
By default, when a user changes team folder permissions on the server, the new permissions are not applied during sync operations. This may give users
undesired access to team folders in FileCloud. Beginning with FileCloud 20.1, you can add a setting that includes team folder permission syncing to the
sync operations of FileCloud Sync and FileCloud ServerSync:
define("TONIDO_PROPAGATE_ACLCHANGES_TOSYNC", 1);
Note: If you have team folders synced, when you upgrade to version 20.1 of FileCloud server and version 20.1 of FileCloud Sync, log out
and log back in to ensure a clean upgrade.
116
Sync Settings
Sync Activity Log
Settings
Other Settings
You can view and control all the sync app's settings from the sync app menu.
7 Syncing status for Managed Files Shows Syncing status for My Files / Team /
117
Shared Folders
8 Syncing status for Network Folders and Backup Show Syncing status for Network Folders and
Backup
9 Recent Log Shows recent sync logs, note that this log will
clear and refresh if there are many entries
16 Skipped Files Allows you to view files that were not synced
and the reason they were skipped.
By default, all activities are shown and you can filter by selecting the filter drop-down and selecting either "Errors" or "Skipped" files.
You can also search activities for a given filename or path by typing in fragments of the string you are searching for.
118
Settings
You can control other options from the settings dialog, including
Account Settings: Change user account and server information used for connection.
Selective Sync: Allows you to select which specific folders get synchronized locally
Network Folders: Allows you to select which network folders get synchronized locally
Backup: Allows you to select which local folders should be backed up
Change Sync Folder: It allows you to change the location where the sync folder is stored. You can move it to a different drive for instance if
storage space is an issue.
Reset All Sync Data: Sometimes, you might want to clear the synchronization state information in the sync app and make it reset all the internal
data. This will make it recreate the sync state again from the server. Note that no files in the sync folder are deleted or affected. ie if the file
already exists locally it will not be re-downloaded.
Other Settings: You can also edit other miscellaneous settings.
Sync settings are shown even when sync is paused so that they can be changed
119
Other Settings
To set other advanced options, you can select Other Settings Edit option to see the Advanced tab.
Some users may see a setting on the Advanced tab called: Allow Remote Management
This setting allows Sync users to manage their Sync application by overriding an Administrator's settings
In some cases, administrators want to disable this toggling
In FileCloud Server version 19.1 and later, this option can be shown or hidden in the Admin Portal
120
Option Notes
Proxy Settings This allows to set the HTTP Proxy settings (a restart of the sync app is
needed) in that case.
Sync Frequency You can change the built-in sync frequency from 120 seconds to
something faster
Disable Notifications Disable all notifications including those about new files uploaded or
downloaded, errors, and new versions.
The ability to only disable notifications about new files uploaded or
downloaded was added in FileCloud Version 19.3. See XML Options for
Sync.
White Progress Icon If you use a dark background, the sync progress icons might not be easily
visible, so in that case you can turn on white progress icon
121
Using DocIQ with Office for Sync Users
DocIQ for FileCloud Sync and FileCloud Sync clients is available in FileCloud Server version 18.2 and later.
DocIQ is a Microsoft Office add-in for FileCloud Sync and FileCloud Drive clients.
Word
Excel
PowerPoint
DocIQ works with Office documents to help you manage shared files.
122
Install DocIQ with Sync
The ability to install DocIQ office integration when Sync or Drive is installed is available in FileCloud Server version 18.2 and later.
DocIQ allows you to easily manage FileCloud options for a file directly in Microsoft Office applications.
To install DocIQ, you just need to update your FileCloud Sync software to the latest version.
FAQ's
for Windows
Sorry, right now Microsoft Office for Mac OS is not supported. But stay tuned!
123
If you have the latest version of Sync and now want to add the DocIQ Integration, you just have to re-run the Sync installation wizard.
You don't have to uninstall Sync first and you won't loose any account mapping configurations after re-running the wizard.
124
Configure DocIQ for Sync
DocIQ gets all configuration information from FileCloud Sync and Drive.
For example, when a file is opened from Sync, DocIQ will know which FileCloud account you are using.
This allows DocIQ to show you information about the file that is uploaded to the FileCloud Server site in the Office application.
There are a few properties that can be configured in Sync and Drive for DocIQ:
<cloudsync>
<officehelperlockonedit>1<
/officehelperlockonedit>
</cloudsync>
125
Work with DocIQ File Locking in Sync
Locking is critical for shared files, since another user can also open the file and make changes.
When one user opens a file, DocIQ automatically locks the file for editing.
The lock is shown right in the Office application you are using to edit the file.
FAQ's
File is not locked when: File is locked (read allowed) when: File is locked (read blocked) when:
The following table describes what each lock status means and how it impacts what you can do with the file and others you have shared it with.
File is locked (read allowed) Read and Modification allowed Only read is allowed, no modification is allowed
File is locked (read blocked) Read and Modification allowed No Read and Modification is allowed
File is not locked Read and Modification allowed Read and Modification allowed
DocIQ will automatically attempt to lock the file, with read allowed status.
126
For a file with a Read Blocked status:
You can use the following table to understand the status of lock:
Action Doc IQ Lock Prevent Lock Status Lock Status Lock Status
An unlocked file is File is not locked File is locked (read File is not locked
opened by USER1 allowed) by USER1
An unlocked file is File is not locked File is not locked File is not locked
opened by USER1
A file locked by USER1 File is Locked (Read File is Locked (Read File is not locked
is opened by USER1 Allowed) by User 1 Allowed) by USER1
A file locked by USER1 File is Locked (Read File is Locked (Read File is not locked
is opened by USER1 Allowed) by User 1 Allowed) by USER1
A file locked by USER1 File is Locked (Read File is Locked (Read Bloc File is not locked
is opened by USER1 Blocked) by USER1 ked) by USER1
A file locked by USER1 File is Locked (Read File is Locked (Read File is Locked (Read
is opened by USER2 Allowed) by USER1 Allowed) by USER1 Allowed) by USER1
A file locked by USER1 File is Locked (Read File is Locked (Read File is Locked (Read
is opened by USER2 Allowed) by USER1 Allowed) by USER1 Allowed) by USER1
A file locked by USER1 File is Locked (Read File is Locked (Read File is Locked (Read
is opened by USER2 Blocked) by USER1 Blocked) by USER1 Blocked) by USER1
Note that you cannot enable Prevent Download unless DocIQ Lock is also enabled.
When you lock a file, you can block other users from reading the file by enabling Prevent download.
Note that you can not enable Prevent Download unless DocIQ Lock is also enabled.
If another user, USER2, attempts to download the file, USER2 will see the following conditions:
127
128
Troubleshoot DocIQ in Sync
Check if file is available in FileCloud by logging into the FileCloud User Portal.
129
If you need to, you can uninstall DocIQ in the following ways:
1. Next to the Start button ( ), in the search box, type Control Panel.
2. From the results, select Control Panel.
3. Select Programs and Features, and then select DocIQ.
4. At the top of the list, next to Organize, click Uninstall.
1. Next to the Start button ( ), in the search box, type Control Panel.
2. From the results, select Control Panel.
3. Select Programs and Features, and then select FileCloudSync.
4. At the top of the list, next to Organize, click Uninstall.
1. Next to the Start button ( ), in the search box, type Control Panel.
2. From the results, select Control Panel.
3. Select Programs and Features, and then select FileCloudDrive.
4. At the top of the list, next to Organize, click Uninstall.
130