1
File Sync System
Tutorial
2
Contents Overview
File Sync System Installation and Configuration
Administering SuperOffice replication with File Sync System
Using File Sync System on a daily basis (Remote Travel users)
Central Server Installation and Configuration
Satellite Server Installation and Configuration
Remote Travel Installation and Configuration
Firedaemon Installation and Configuration
Page 2
Page 3
Page 13
Page 21
Page 26
Page 30
Page 36
3
Contents Overview
File Sync System Installation and Configuration
Administering SuperOffice replication with File Sync System
Using File Sync System on a daily basis (Remote Travel users)
Central Server Installation and Configuration
Satellite Server Installation and Configuration
Remote Travel Installation and Configuration
Firedaemon Installation and Configuration
Page 2
Page 3
Page 13
Page 21
Page 26
Page 30
Page 36
4
Server Installation
• Install FSS on the server where so_arc is located on a Physical Harddisk
► Install from www.kontineo.com/download/File Sync System 2007 Install.exe
► Installs in …[SuperOffice]\Modules\Kontineo\File Sync System 2007
► If SuperOffice not present, in [PROGRAM_FILES]\Kontineo\File Sync System 2007
5
Server Configuration
• Start File Sync System 2007
► If SuperOffice is installed, Click AutoConfig (SuperOffice launches, you must log on)Otherwise you must set all setting manually
Check all settings - (SPECIAL ATTENTION TO SO_ARC) - click Test
Approve settings, Save and Close
1. SuperOffice Installation type = Central
3. Connection to SuperOffice Central SQL Database 4. SO_ARC
MUST be directory on local harddiskDO NOT use UNC path or mapped drive.
2. Click AutoConfig
5. Click Test
7. Tick 'Yes, all settings are approved, Save and Close
Note: If SuperOffice is not installed, you must Manually configure. An ODBC DSN to SuperOffice must exist.
6
Server Configuration and License Activation
If No License is installed, the License Activation Screen will appear.
1. WEB ActivationLoads a License using WEBservice if one exists - otherwise a temporary key is created
1a. File ActivationLoads a License from a License File sent from Kontineo. Use this or Manual Activation if WEB activation is blocked.
2. Tick "I Accept"… and Click Next
3. It will ask for SuperOffice Serialnumber (SuperOffice must be started).Click "Load" and next.
4. It will ask you to confirm e-mail address. License information and product information will be sent to this e-mail. Click OK
Note: If SuperOffice is not installed, you must use Manual Activation
You do not need to ask KONTINEO for a License Key. WEB Activation will
automatically create a 30 days trial License Key.
Tips & Tricks
7
ii) You can at all times access this screen from the Help Menu -> License Management
i). License Activation brings you to this screen
1. If new license issued, click to refresh (remember save)
2. Tick of Users whom should have FSS License (Must also have Superoffice Remote Travel). (Save)
3. Tick of Satellites that should have FSS License. (Save)
Server Configuration and License Management
8
Server ConfigurationFSS Remote Travel Auto Deployment
• Copy \File Sync System 2007\Soloader_kontineo_fss.ini to \SuperOffice\Client on central server. This distributes FSS to all clients.
• Configure Auto Deployment Settings for Remote Travel users of respectively server of each Satellite
► Central trigger creates signal file after having copied up-file to server (Recommended on installations op to 10 Remote Travel Users. Creates many dwn files)
► Local Trigger uses Travel Gateway for Remote Travel users (Recommended)
► Allow Background Sync (Recommended). FSS starts when SuperOffice starts – and continues background sync even if SuperOffice is closed. (Background Sync requires Local Trigger).
Note 1: Using the so_loader, FSS will be installed on all workstations. Client not on Remote Travel will not be affected (FSS Starts – and shuts down when it finds out the user is not on Remote Travel)
Note 2: Grant License Automatically Grants User License to Remote Travel Users. Be aware, that licenses for retired associates are not removed (Must be done manually) – too many users granted license will cause FSS to deny synchronization for all.
You can run test databases with Background sync running. It is NOT affected, except if testing
Travel.
Tips & Tricks(For Superoffice consultants)
9
Server ConfigurationTravel Gateway Configuration
• With Central Trigger enabled on clients
► Read Updates from all users, When signal file exists
► Write updates to all users, Immediately after preceding activity
• With Central Trigger disabled on clients
► Read Updates from all users, Interval 30 minutes
Set preferred interval, between 30 minutes and 3 hours is best practise
► Write updates to all users, Immediately after preceding activity
With Central Trigger enabled you will obtain full Two Ways Sync confirmed by two green arrows in
user interface. See “Using File Sync System on a daily basis ”
section later.
Tips & Tricks
10
Server ConfigurationAutostart Configuration
• Configure to start with Windows login► Copy the ”Start File Sync System” shortcut to the
Windows ”StartUp” folder.
• Configure to run as a service► See section about FireDaemon
This is NOT a recommendable method. If using Remote Desktop to connect it causes Multiple instances
(applies to SuperOffice Travel Gateway as well). See the section about FireDaemon configuration
later.
Tips & Tricks
11
Server ConfigurationSuperOffice Application List Entries
• Add File Sync System 2007 (SO Started) application entry
► Add as ”Event”► File Name: ”Modules\Kontineo\File Sync
System 2007\FileSystemSynchronizer.exe”
► Parameters: ”SOSTARTED”
► Run When: ”SuperOffice SIX starts”
• Add File Sync System 2007 (SO Closed) application entry
► Add as ”Event”► File Name: ”Modules\Kontineo\File Sync
System 2007\FileSystemSynchronizer.exe”
► Parameters: ”SOCLOSED”► Run When: ”SuperOffice SIX exits”
FSS start automatically with SuperOffice. If on Remote Travel it will start and run. On central it
will start – and immediately shut down. If on Remote Travel, and not configured, it will
configure itself (If Auto deployment is enabled).
Tips & Tricks
12
Server ConfigurationSuperOffice Preferences
• Travel - Show Travel Menu► Recommended enabled for Remote Travel
Users and Key Central Users
• Travel – Prevent Central Update► Recommended enabled for Remote Travel
Users
If an up-file or dwn file has become corrupt, it makes troubleshooting much easier if the Remote Travel user can Write a new file – and at
Central, if a SuperOffice Administrator has the menu in SuperOffice to write a dwn file
manually.
Tips & Tricks
Remote Travel users should stay on Travel, only making a Central Update when the file sequence
becomes high (before the 10.000 limit). Prevent Central update avoids “accidental” Yes replies
taking the user off travel.
Tips & Tricks
13
Contents Overview
File Sync System Installation and Configuration
Administering SuperOffice replication with File Sync System
Using File Sync System on a daily basis (Remote Travel users)
Central Server Installation and Configuration
Satellite Server Installation and Configuration
Remote Travel Installation and Configuration
Firedaemon Installation and Configuration
Page 2
Page 3
Page 13
Page 21
Page 26
Page 30
Page 36
14
Satellite Installation
• Install FSS on the satellite server where so_arc is located on a Physical Harddisk
► Install from www.kontineo.com/download/File Sync System 2007 Install.exe
► Installs in …[SuperOffice]\Modules\Kontineo\File Sync System 2007
► If SuperOffice not present, in [PROGRAM_FILES]\Kontineo\File Sync System 2007
15
Satellite Configuration
• Start File Sync System 2007
► If SuperOffice Present, Click AutoConfig (SuperOffice launches, you must log on)Otherwise you must set all setting manually
Check all settings (Follow the steps 1-7 below)
Continues Next page…
1. SuperOffice Installation type = Satellite
6. After Test central connection, select Satellite Area from Drop Down list.
7. Manually type in S1 or the folder in so_arc where Up and Dwn files are stored.
3. Set connection info to SuperOffice Central SQL Database (is not auto configured. ODBC DSN must be manually created).
4. SO_ARCis UNC path to SuperOffice Central archive path.
2. Click AutoConfig
5. Click Test
16
Satellite Configuration
• Continued…
12. Enable Automatic Sync and set synchronization interval.
9. Check connection info to SuperOffice Satellite SQL Database (is auto configured, but may need adjustment).
10. SO_ARCMUST be directory on local harddiskDO NOT use UNC path or mapped drive.
8. Click Satellite Database
11. Click Test
13. Tick 'Yes, all settings are approved, Save and Close
17
Satellite ConfigurationDocument Filters and synchronization settings
• Check/set all settings in below steps 1-6
• Approve settings, Save and Close
1. Enable Document filters if required.
3. “Enable Full Sync” is often enabled on Satellites, configured to run once during night time. (Recommended on Satellites).
4. Central and Local Travel Gateway triggers should be enabled if Travel Gateways are configured (Not recommended if above 10 RMT users)
2. “Skip sync Templates” is only set if templates differs from central (Not recommended) “Enable Thin Line detection” is usually only set for Remote Travel Users connecting with Mobile devices. (Not recommended on Satellites)
6. Tick 'Yes, all settings are approved, Save and Close
“Limit files to Area” is always forced enabled
for satellites and “Synchronize Files Back
To” is default set to current period. Other filters are used only in special circumstances.
Best Practise is to set period back and run a
full sync, and then set it up to previous period
again.
Tips & Tricks
5. Popup can be configured as wished.
18
Satellite ConfigurationTravel Gateway Configuration
• With Central Trigger enabled on clients of the Satellite
► Read Updates from all users, When signal file exists
► Write updates to all users, Immediately after preceding activity
• With Central Trigger disabled on clients of the satellite
► Read Updates from all users, Interval 30 minutes
Set preferred interval, between 30 minutes and 3 hours is best practise
► Write updates to all users, Immediately after preceding activity
With Central Trigger enabled you will obtain full Two Ways Sync confirmed by two green arrows in
user interface. See “Using File Sync System on a daily basis ”
section later.
Tips & Tricks
19
Satellite Server ConfigurationAutostart Configuration
• Configure to start with Windows login► Copy the ”Start File Sync System” shortcut to the
Windows ”StartUp” folder.
• Configure to run as a service► See section about FireDaemon
This is not a recommended method. If using Remote Desktop to connect it causes Multiple instances (applies
to SuperOffice Travel Gateway as well). See the section about
FireDaemon configuration later.
Tips & Tricks
20
Satellite ConfigurationRun Full Sync
• Run a ”Normal Quick Sync All”► This verifies files that have been recently
changed (Logged by FSS on the server and satellite).
► It is fast!
• Run a ”Full Synchronisation –> All Files”► This verifies all files ”the old way” between
the central and the server according to your Synchronization Filters.
► It will take time!
21
Contents Overview
File Sync System Installation and Configuration
Administering SuperOffice replication with File Sync System
Using File Sync System on a daily basis (Remote Travel users)
Central Server Installation and Configuration
Satellite Server Installation and Configuration
Remote Travel Installation and Configuration
Firedaemon Installation and Configuration
Page 2
Page 3
Page 13
Page 21
Page 26
Page 30
Page 36
22
Remote Travel ClientInstallation
• If distributed using so_loader► nothing needs to be installed
• If not distributed using so_loader► Install from www.kontineo.com/download/File Sync System 2007 Install.exe
You can install File Sync System for active Remote Travel users. You do not need to have them come into
in the Office or have a central update performed.
Tips & Tricks
File Sync System can run parallel with normal Remote Travel. If users after implementing File Sync System uses the “Travel button” as they used to, it does no
harm – it is just not necessary any longer.
Tips & Tricks
23
Remote Travel ClientConfiguration
• If configured for Autodeployment► Nothing – will automatically be configured when SuperOffice starts after the user has gone out
on Remote Travel
• If Not configured for Autodeployment► Start File Sync System 2007 and follow the steps below (Continues next page…)
1. SuperOffice Installation type = Remote Travel
6. After Test central connection, select user from Drop Down list.
3. Check connection info to SuperOffice Central SQL Database (is auto configured).
4. SO_ARCis UNC path to SuperOffice Central archive path (as in SuperOffice.ini)
2. Click AutoConfig
5. Click Test
24
Remote Travel ClientConfiguration
• Continued… (Only applicable if not configured for Auto deployment)
10. Enable Automatic Sync and set synchronization interval and set Superoffice User ID and Password.
8. Check connection info to SuperOffice Travel SQL Database (is auto configured, and should not need adjustment).
7. Click Travel Database
9. Click Test
11. Tick 'Yes, all settings are approved, Save and Close
25
Remote Travel ClientDocument Filters and synchronization settings
• Check/set all settings in below steps 1-6
• Approve settings, Save and Close
1. Enable Document filters if required.
3. “Enable Full Sync” is rarely enabled on Remote Travel.
4. Central Travel Gateway triggers should be enabled only if central Travel Gateways is configured for it. Local Travel Gateway Trigger and Allow Background Sync is recommended enabled.
2. “Skip sync Templates” is not recommended) “Enable Thin Line detection” is set for Remote Travel Users connecting with Mobile devices. (Thin Line Milliseconds may need testing usually between 1000 and 5000 milliseconds)
6. Tick 'Yes, all settings are approved, Save and Close
“Limit files to Area” is always forced enabled if the user is assigned to
an area.
The user may run a full sync to retrieve
colleague documents in one go, but can
otherwise use “Sync Current Document”
when a document that does not exist is wanted.
Tips & Tricks
5. Popup can be configured as wished.
You can set document filters to limit the data traffic as to your wishes. The “Sync SuperOffice Current
Document” overrides the filters and will therefore retrieve a document even if it is excluded in filters.
Tips & Tricks
26
Contents Overview
File Sync System Installation and Configuration
Administering SuperOffice replication with File Sync System
Using File Sync System on a daily basis (Remote Travel users)
Central Server Installation and Configuration
Satellite Server Installation and Configuration
Remote Travel Installation and Configuration
Firedaemon Installation and Configuration
Page 2
Page 3
Page 13
Page 21
Page 26
Page 30
Page 36
27
FireDaemon
• Firedaemon is a third party software that runs non-windows service applications as if they were windows service applications.
► They start automatically when windows start (without logon)► They restart automatically if a crash should occur► They can be restarted e.g. once per day, if a ”hangin” situation should occur
• Purchase and Download Firedaemon Pro from www.firedaemon.com.► Install it and start the Firedaemon Service Manager► The next pages will describe best practise setups, but you may to explore the opportunities of
Firedaemon further for the best possible setup in your environment.
28
FiredaemonTravel Gateway Service Configuration
• Install a new service and set it up as below and to the right.
29
FiredaemonFile Sync System 2007 Service Configuration
• Install a new service with settings as pictured for
► Filesystemsynchronize.exe Parameter=servicemode
► Filesystemlayer.exe► Filesystemlistener.exe
► All Logon Account (Must have Local Administrative
rights) Schedule a Restart=Every 24 hours
30
Contents Overview
File Sync System Installation and Configuration
Administering SuperOffice replication with File Sync System
Using File Sync System on a daily basis (Remote Travel users)
Central Server Installation and Configuration
Satellite Server Installation and Configuration
Remote Travel Installation and Configuration
Firedaemon Installation and Configuration
Page 2
Page 3
Page 13
Page 21
Page 26
Page 30
Page 36
31
Using File Sync System on a daily basis
Using File Sync System on a daily basis is very easy. It starts when you start SuperOffice and the only thing you will see is the small icon in the system tray.
However, it can only synchronize when it can “see” the server, so you must regularly be connected.
File Sync System regularly makes a “can I see the server” check. If it can, it starts synchronizing of SuperOffice data to and from the server, as well as it copies new or changed documents to and from the server.
Working in the OfficeEnable Wireless Network or plug in a network cable,
start SuperOffice and remain on Travel.File Sync system keeps you constantly up-to-date.
You may run a “Full Synchronization – All Files” will ensure that you have all colleague documents.
Working from homeConnect to the network and start SuperOffice.
File Sync system keeps you constantly up-to-date while you work on-line.
You may manually run a “Normal Quick Sync (All)” to make sure it synchronizes while you are on-line.
32
Getting a document not available on Travel
In SuperOffice, you may get a messagelike the one to the right when you are on Travel.
This is (usually) because the file does not exist.
If you are connected to the central network,you can right click the File Sync System Iconand select “SuperOffice Current Document” – and in a few seconds you will get the below message confirming that the file has been copied.
A missing file on Travel is only two clicks away. Right click and select “SuperOffice Current
Document”
Right Click
33
Replication warnings
File Sync System has three different replication warning levels. A marking in the icon indicates the warning level, and you will also be warned with pop-up.
High Warning Level: When it is more than 24 hours since two-way replication was confirmed successful. When the warning level is High, a red dot appears in the icon.
Low Warning Level: When it is more than 6 hours but less than 24 hours since two-way replication was confirmed successful. When the warning level is Low, a yellow dot appears in the icon.
OK level:When it is less than 6 hours since two-way replication was confirmed successful. When the level is Ok, a small green tick appears in the icon.
User settings allow the user to receiveStatus Popup messages at each level.The message appears for 5 secondsand then disappears again.
If you get the red dot, you should run a “Normal Quick Sync”.
If it remains red, you should notify
your Administrator.
34
Understanding Replication warnings
In the Popup Message, you may get red arrows, yet still remain a Green Tick mark in your icon.
The red arrows does not necessarily mean that something is wrong, but the reason is that some installations are configured without “Central Gateway Trigger” because it generates too many files.
In that case, a file that you send to the server will not be read until a specified time. Usually it can be up to three hours apart.
You should not be concerned, until your icon shows a Red dot.
A red arrow is not reason for concern – only if you get a red dot in your icon is there reason for alert.
Two green arrows tells you that your have been fully two ways synchronized – they have all
your data centrally, and you have theirs.
35
To achieve a complete overview of the replication status, you can right click the File Sync System icon and then select “Show”.Under ‘Replication Status’ (marked with red) you can see the status of you replication and see the dates and times of last successful synchronization.
Using File Sync System on a daily basis
1.2.
36
Contents Overview
File Sync System Installation and Configuration
Administering SuperOffice replication with File Sync System
Using File Sync System on a daily basis (Remote Travel users)
Central Server Installation and Configuration
Satellite Server Installation and Configuration
Remote Travel Installation and Configuration
Firedaemon Installation and Configuration
Page 2
Page 3
Page 13
Page 21
Page 26
Page 30
Page 36
37
In File Sync System on the Central Server you can access the Replication Status Monitor.
It gives you a list of all Satellites and Remote Travel Users usingFile Sync System, and the status at the last synchronization.
Administering SuperOffice Replication with FSSThe Replication Status Monitor
The data showed above gives you the ability to identify if there are any problems, and to a very largeextent also what the problem is – and thereby making it easy to eliminate the problem.
A good Practise to improve replication stability would be to regularly check the Replication Status Monitor.
38
You may consider to implement a more advanced Replication Monitoring solution, that automaticallyalerts about problems by e-mail to an administrator.
Administering SuperOffice Replication with FSSReplication Monitoring Solution (Additional License)
The solution sends an alert only if something indicates a problem.
A nice feature is that it excludes users on vacation etc., so that you don’t get “incorrect warnings”.
The solution is an add-on to File Sync System and requires an additional license.
Contact KONTINEO for further information.
39
SuperOffice Replication Administration with File Sync System Best Practise.
Ensure Travel Gateway and File Sync System stability1. Configure Travel Gateway and File Sync System at servers with Firedaemon2. Remember: If the services start-up account changes password, it must be changed in
services
User Configuration1. Configure File Sync System with Auto Deployment Default Configuration2. If users retire or new users are added, remember configuration in File Sync System License
Management
Client installation and upgrade1. Configure File Sync System to be distributed with soloader.exe2. Perform FSS upgrades at all servers (Stop services and run install over the existing). Let
soloader.exe distribute to clients.3. Check FSS Version in Replication Monitor to check that the latest version has been
distributed to all clients.
Avoid Problems1. Don’t just wait for users to tell about problems – use the monitor regularly to see if any
problems exists – correct them before they become problemsa) The Replication Monitor solution with automatic e-mail alert may be considered as an
alternative
Problem identification and elimination• Use Replication Monitor to see where a problem lies (which file number has caused a
problem)• Use “Write update” in Travel Menu/SO Administrator/Travel gateway to Rewrite down files
when this is the problem (it is the most common problem)
Administering SuperOffice Replication with FSS