Skip to main content
System StatusContact Support
VersionOne Community

TeamSync

This feature is available in Ultimate edition only.

editions-u.png

VersionOne TeamSync is an integration that provides portfolio and program managers with visibility into work that their teams are doing without disrupting the teams' current agile processes. TeamSync is designed from the ground up to allow VersionOne to coexist and blend with other agile team tools while providing accurate and near-time rollup of the features that the teams are working on, including their backlog workitems, estimates, statuses, and effort. 

Using TeamSync, organizations can effectively plan their product releases and features in VersionOne, elaborate those features into workitems items in their external team tool, then as the team executes those workitems within their team tool, roll up the status and effort on those workitems as the teams progress through their agile iterations.

Key features of TeamSync include:

  • Synchronize multiple team tool instances into a single VersionOne instance

  • Synchronize multiple projects per team tool instance

  • Specify the VersionOne Portfolio Item level to send as features to the team tool

  • Maintain workitem status in near-time

  • Aggregate and roll up workitem estimates and worklogs (effort) to the portfolio and program levels in VersionOne

  • Simple installation and configuration

​TeamSync Connectors

TeamSync provides connectors for the following team tools:

​TeamSync Requirements

TeamSync requires the following:

  • Windows operating system that supports .NET Framework 4.5.1

  • VersionOne Ultimate Edition, Summer 2014 release or greater

  • HTTP access to VersionOne and the team tools being synchronized

  • A VersionOne member account with a Team Member project role or higher permissions

Specific team tool requirements are described in the team tool topics listed in the TeamSync Connectors section above.

TeamSync Components

TeamSync is comprised of two major components:

  1. Windows Service: A continuously running service that synchronizes data between VersionOne and multiple external team tool servers and projects.

  2. System Tray Application: An application that allows you configure, manage, and view the activity of the TeamSync Windows service.

Installing TeamSync

Installing TeamSync is a simple process that involves running a Windows Installer program that will copy the program files to a specified directory, install the TeamSync Windows service, and install the TeamSync system tray application.

You must have Administrator level privileges to run the installer as it is required for the system tray application to manage the Windows service.

Once you've downloaded the TeamSync MSI, simply open a command prompt with "Run as administrator", then execute the following command:

msiexec /i VersionOne.TeamSync.Intaller.msi

A wizard will launch that allows you to accept the license, specify the installation directory, and execute the installation process. When the installer completes, you'll find that the TeamSync program files are located (by default) in the C:\Program Files (x86)\VersionOne TeamSync directory, and that the TeamSync system tray application is available in the Windows system tray.

To uninstall TeamSync you can use the Windows Control Panel or open a command prompt and execute the following command:

msiexec /x VersionOne.TeamSync.Intaller.msi

While not a requirement, you should exit the TeamSync system tray application before uninstalling TeamSync to ensure that that removal process is successful.

Configuring TeamSync

Configurations for TeamSync are stored in the VersionOne.TeamSync.Service.exe.config file, which is an XML file located in the TeamSync installation directory. You may access this file using Windows Explorer or more easily, by selecting Configure from the TeamSync system tray application menu. Selecting Configure will open the config file using Microsoft Notepad.

TeamSync supports the following general configurations:

  • Log Settings: These settings control how TeamSync service activity is logged including the message format and verbosity.

  • Service Settings: These settings control how often a synchronization occurs.

  • VersionOne Settings: These settings are used to set the target VersionOne instance and how the service authenticates to it.

This section applies only to general TeamSync configurations. Each team tool connector has its own specific configurations and settings, and those are described in the team tool topics listed in the TeamSync Connectors section above.

Log Settings

The log settings control how the TeamSync service activity is logged including the message format and verbosity. TeamSync uses Apache log4net as its logging framework, and supports all of the normal configurations that log4net provides.

TeamSync makes use of two log appenders:

  • RemotingAppender: This appender is used to send log messages to a specific port and is the appender that is used by the Activity View window to show the current activity of the service. By default, this appender is set to the ALL log level.

  • RollingLogFileAppender: This appender is used to send log message to a file. Log files are located in the TeamSync application folder in a logs subdirectory. By default, this appender is set to the WARN log level.

Keep the RemotingAppender log level set to ALL so that all log level messages will be available in the Activity View window.

The log levels supported by TeamSync as as follows:

INFO The least verbose level. This logging level provides information regarding when the integration was initialized, if connecting to VersionOne and the target systems was successful, and basic information about progress of the workflow synchronizations that the integration supports such as when a synchronization occurs and the number of items that were synchronized.
DEBUG More verbose than INFO, but less verbose than TRACE. This logging level provides more detailed information regarding the workflow synchronizations that the integration supports including each asset that is being synchronized and the type of action taken.
WARN Used for issues that are not errors and are not fatal, but may effect how synchronization occurs. For example, if a project mapping is invalid, that project will not be synchronized but the integration will continue to synchronize other valid projects.
TRACE The most verbose logging level and should only be used for deep diagnosis and troubleshooting of integration issues. This logging level provides information about key methods that are called, the parameters passed to those methods, and the HTTP request and response information for all calls made to the VersionOne API. This level is appropriate for use by support engineers to help diagnose integration issues. In general, this logging level should be avoided as it will result in a rapid increase in the size of the log file.
ERROR This logging level is always in effect and provides information about any errors that may have occurred within the integration.
ALL Enables all of the logging levels. In general, this logging level should be avoided as it will result in a rapid increase in the size of the log file.

Here's an example of the log settings as they appear in the TeamSync configuration file:

<!-- Logger settings. -->
<log4net>
   <appender name="RemotingAppender" type="log4net.Appender.RemotingAppender" >
      <bufferSize value="1" />
      <sink value="tcp://localhost:8086/LoggingSink" />
      <lossy value="false" />
      <onlyFixPartialEventData value="true" />
      <filter type="VersionOne.TeamSync.Core.LevelFilter, VersionOne.TeamSync.Core">
         <level value="ALL" />
      </filter>
   </appender>

   <appender name="RollingLogFileAppender" type="log4net.Appender.RollingFileAppender">
      <file type="log4net.Util.PatternString" value="logs/VersionOne.TeamSync.Service.%date{yyyy-MM-dd}.log" />
      <appendToFile value="true" />
      <rollingStyle value="Date" />
      <datePattern value="yyyyMMdd" />
      <layout type="log4net.Layout.PatternLayout">
         <conversionPattern value="%date %-5level %logger - %message%newline" />
      </layout>
      <filter type="VersionOne.TeamSync.Core.LevelFilter, VersionOne.TeamSync.Core">
         <level value="WARN" />
      </filter>
   </appender>

   <root>
      <level value="ALL" />
      <appender-ref ref="RollingLogFileAppender" />
      <appender-ref ref="RemotingAppender" />
   </root>
</log4net>

Service Settings

The TeamSync service contains one general setting called syncIntervalInSeconds, and it it used to specify the time in seconds to wait between synchronization events. By default, the interval is set to 1800 seconds, or 30 minutes.

Here's an example of the syncIntervalInSeconds setting as it appears in the TeamSync configuration file:

<!-- General settings -->
<serviceSettings syncIntervalMinutes="10" />

It is recommend that the sync interval be no smaller than 1800 seconds, or 30 minutes. However, you may be able to use a smaller interval if you have very few servers and projects being synchronized.

VersionOne Settings

TeamSync is designed to synchronize data from multiple team tool instances into a single VersionOne instance, and the settings for the target VersionOne instance includes the VersionOne instance URL, the authentication type and credentials used by the service to communicate with VersionOne REST API, and the proxy settings.

TeamSync supports authenticating with with Access TokenBasic (username/password), or Windows Integrated authentication.

Here's an example of the VersionOne settings as they appear in the TeamSync configuration file:

<!-- VersionOne settings -->
<!-- Authentication Type: 0=AccessToken, 1=Basic, 2=WIA Current User, 3=WIA Specified User, 4=WIA Access Token -->
<v1Settings authenticationType="0" url="http://localhost/VersionOne" accessToken="1.Ng/9sgEywQ/9GxxLdP961FOE3Nw=" username="" password="">
   <proxy enabled="false" url="http://proxyurl" domain="proxydomain" username="proxyuser" password="proxypwd" />
</v1Settings>

The VersionOne member account that you use for the TeamSync service credentials should have Team Member project role or higher privileges on all the projects that you want to have synchronized.

Running TeamSync

TeamSync is a Windows service that once configured, runs quietly in the background with no user interaction. Running the TeamSync is simply  matter of starting the service, then if desired, using the Activity View Window to view the service activity.

Starting the Service

There are multiple ways that the TeamSync service can be started including from the Windows Services screen, using the net command line tool, or by using the TeamSync system tray application. The TeamSync system tray application menu includes items to start, stop, and recycle the service, as does the Activity View window.

By default, the TeamSync service is set to start automatically on system start up.

Viewing Service Activity

The TeamSync system tray application includes an Activity View menu item that when selected, opens a window that you can use to view the log messages that the TeamSync service is generating as it performs synchronizations. Activity View also includes a drop down list that you can use to filter the log messages that appear.

When you close the Activity View window, the window size and log level selections will be saved and used the next time you launch the Activity View.

Note that the log messages are not always sequential as TeamSync is designed to perform many of its actions asynchronously, meaning that it attempts to efficiently process nondependent activities at the same time.

Troubleshooting TeamSync

The following are some common issues that may occur when trying to use TeamSync:

The TeamSync system tray application is not available in the Windows system tray.

You may need to start the system tray application manually. To do so, open Windows Explorer and navigate to the TeamSync installation folder, which by default is C:\Program Files (x86)\VersionOne TeamSync. Right click on the file named VersionOne.TeamSync.SystemTray.exe and select Run as administrator. This should launch the system tray application and you should see the VersionOne icon in the Windows system tray.

The Start, Stop, and Recycle menu items are grayed out in the system tray application.

This can occur if the TeamSync service is not installed properly, or if you are not running the system tray application with administrator privileges. Open Windows Services from Adminstration Tools and check that you have a service named VersionOne TeamSync Service. If you do not, try running the TeamSync installer. In addition, try exiting the system tray application then restarting it with administrator privileges

The TeamSync service is unable to connect to VersionOne.

This can happen as a result of an invalid URL, incorrect credentials, or an issue getting HTTP access to your VersionOne instance. Try opening VersionOne directly using a browser on the machine that TeamSync is running on.

Getting Help with TeamSync

While we strive to make TeamSync as easy to use as possible, however you may still occasionally need some help, and there are a few different ways you can get it:

  • StackOverflow: For asking question of the VersionOne Developer Community.

  • VersionOne Support: Our support team is well versed in TeamSync and can advise and help troubleshoot.

  • VersionOne Technical Services: A paid support offering, this team provides API training, development pairing, and complete custom development services.

More Information

For more information about TeamSync, see the following:

 

  • Was this article helpful?