Installing Sync as a Windows Service
This document describes how to install and configure Tasktop Sync as a Windows service.
Detailed instructions on system requirements, license activation and installation preparation are available in the Installation Guide. Note that you will need to complete the steps on user setup before you can import the license file.
To install as a Windows service, make sure to check the option for it provided in the installation options page of the wizard.
When installed as a Windows service, Tasktop Sync should not run as the Local System account and should be run as a specific user account with the following permissions:
- permission to run a service
- read and write permission in Tasktop Sync’s workspace directory and all its sub-directories (default location:
C:\Documents and Settings\All Users\Application Data\TasktopSync)
- read permission on the install directory and all its sub-directories (default location:
C:\Program Files\Tasktop Sync)
- write permission on just the top level install directory
If that is not possible, consult the Known Limitations below for a workaround.
To configure Tasktop Sync to use the Administrator user account:
- Open the Windows Services application by going to Administrative Tools -> Services.
- Scroll down to the Tasktop Sync Service as shown:
- Right click on the Tasktop Sync service and select properties, you should see the following dialog:
- Select the "This account" radio button and enter in the Administrator account and the password.
- Select "OK".
- Navigate to the directory where Tasktop Sync has been installed (typically @C:\Program Files (x86)\Tasktop Sync@).
- Right-click on the @TasktopSync.exe@ file and select Properties.
- Under the Compatibility tab, click the "Change Settings for all users" button.
- Select the "Run this program as an administrator" radio button under the Privilege Level heading and click "Apply".
Note: You must use the Windows Service application to configure the services user account (you cannot use the Tasktop Sync Service Manager). This known limitation is described in the Known Limitations .
Task Mapping Configuration and Maintenance
To access the Tasktop Sync user interface, you must login as the user account used to run the Tasktop Sync service.
Before you can access the UI you must shutdown the Sync service if it is running. To check whether the service is running and shut it down, run the Tasktop Service Manager application (from the Windows start menu) installed as part of the installation process. You will see the following dialog:
If the service status is started, you should shutdown the service by clicking the "Stop" button. Once the service has been stopped, access the Sync user interface by running the Tasktop Sync application installed as part of the installation process (typically @C:\Program Files (x86)\Tasktop Sync\Tasktop Sync.exe@). If after running the Sync application you receive an error that another process is using the workspace, this indicates that the service has not been shutdown or has not finished shutting down.
For further details on using the Tasktop Sync UI, please consult the user guide.
Once the task mapping configuration has been completed and Sync has been verified as working you can resume running it as a service in the background. To do this, exit the Tasktop Sync UI by closing the window or selecting "Exit" from the Tasktop menu.
You may now use the Tasktop Sync Service Manager to restart Sync in the background by clicking "Start."
Data Directory Location
Tasktop Sync stores log files and other information in a data directory. The location of this directory varies depending on which operating system Sync has been installed on.
- On Windows 2008 Server, Windows Vista, Windows 7: $TASKTOPSYNC_HOME = @C:\ProgramData\TasktopSync@
- On Windows XP, Windows 2003 Server: $TASKTOPSYNC_HOME = @C:\Documents and Settings\All Users\Application Data\TasktopSync@
Note that these directories are different than the directories used by default if Sync is not installed as a service. See migrating for details.
Starting and Stopping the Service
Starting and stopping the Sync service can be done using the Tasktop Sync Service Manager installed as part of the installation process. You will be asked for an administrator password when running this application because interacting with Windows services requires administrative permissions.
After running this program you will be presented with a dialog:
This dialog contains buttons allowing you to start and stop the service.
Migrating From an Application Only Install
If you have previously installed and configured Tasktop Sync as an application only (i.e. not as a Windows service), it's likely that your configuration folder is in a different location than where the service is expecting. To migrate your configuration to a service install:
- Copy your existing configuration files to the data directory as specified above . (e.g. copy @C:\Users\<User>\AppData\Roaming\TasktopSync\workspace@ to @C:\ProgramData\TasktopSync\workspace@.
- If you'll be running Tastkop Sync as a service under a different user account than you were previously then you'll need to launch the user interface to enter your passwords again.
The Tasktop Sync user interface does not start and stop the Windows service.
The Tasktop Sync user interface is being generated by the service itself, so the service must be started and stopped outside of the Tasktop Sync user interface.
Work Around: See the section on starting and stopping
Tasktop Sync's user interface is not accessible if the service is already started.
The Tastkop Sync configuration files can only be accessed by one process at a time so it's not possible to access the user interface from the application while the service is running.
Work Around: The service must be stopped before starting the application. See the section on starting and stopping the service.
Setting the log on account in the Tasktop Sync Service Manager does not work.
The service manager will not save changes made to the log on account.
Work Around: Open the Windows Services application by going to Administrative Tools -> Services. Scroll down to the Tasktop Sync Service, right click on it, and select properties. Enter account credentials in the Log On tab.
Credentials in secure storage are not shared when switching the user account Tasktop Sync is being run under.
The secure storage used by Tasktop Sync is tied to the user who is running Tasktop Sync. If Tasktop Sync is configured when running as an one user, then switched to run as another user, it will be using a new secure storage and none of the previously entered passwords will be available.
Work Around: When changing user accounts, start the user interface and ensure that all repository passwords are entered again and saved.
When Running as a Local System User
It's strongly recommended that Tasktop Sync be run using a standard account and not the Local System user (see User Setup ). If this is not possible for some reason there are a number of limitations that will be encountered:
Running the service as a Local System user prevents accessing the user interface when running as an application.
Windows enforces file system permissions such that files accessible by services run as the Local System user are not accessible by programs run as applications. In some cases Windows may seem to allow access to the same file at the same location in the file system, but in fact the files can be different for the service and the application. This can happen even if both users have Administrator privileges. The result of this is that Tasktop Sync when run as an application cannot access the configuration files when run as a service under the Local System account.
Work Around: To access Tasktop Sync's user interface when it's running as a service under the Local System account you need to enable the service to interact with the desktop. This can be done in the "Log On" section of the service manager. Open the service properties (right-click on the service in the Windows service list and select properties), select the "Log On" tab, and check "Allow service to interact with the desktop".
Starting the service at this point will pop up a dialog asking for permission to access the service's interface. Click "View the message" to access the Tasktop Sync user interface.
When running as the Local System user the Tasktop Sync user interface is not visible in screen sharing sessions.
The interactive desktop feature of Windows services does not allow its window to be visible across remote screen sharing sessions.
Work Around: Screen sharing will work in conjunction with an RDP session. Instead of running the conferencing software on the same machine as Tasktop Sync, run it on a different machine and RDP into the Tasktop Sync machine. The screen will be visible over the RDP session and the RDP session can be screen shared over the conferencing software.
Tasktop Sync's user interface is not accessible if the service is already started using the Local System user.
Once the service has been started it's not possible to force the user interface to activate when running as a Local System user.
Work Around: Ensure the service has permission to interact with the desktop , then restart the service.
In RDP sessions the Tasktop Sync user interface is only available on the "console session" of a Windows server.
When logging into a Windows server using RDP, even as the Administrative user, the RDP login is not the console session on the server. This can cause problems when attempting to configure Tasktop Sync when it is installed as a Windows service. The Tasktop Sync dashboard is only available on the console session of a Windows server when it has been installed as a service. The symptom of this problem is that Tasktop Sync dashboard does not appear after selecting "Allow service to interact with the desktop" in the Tasktop Sync Service Manager and restarting the service.
Work Around: Instead of using the standard Remote Desktop Connection client on your workstation, open up a command prompt and use the following command:
mstsc /admin /v:tasktopsync.example.com
You should replace tasktopsync.example.com with the hostname of the computer running Tasktop Sync in the above command. This command will open a remote desktop session to the Windows server that uses the console session which allows Tasktop Sync configuration to function normally.