IssueNet Online Help System

www.elsitech.com

IssueNet Source Control Integration

Modified: 2010/02/19 14:35 by Sean White - Uncategorized

Edit

1 System Requirements

The integration requires IssueNet 5.1 or greater with the IssueNet Intercept solution installed. The integration supports the following source controls systems:
  • Microsoft Team Foundation Server
  • Subversion
  • SourceGear Vault
  • Microsoft Visual SourceSafe
  • Perforce
  • AccuRev

Edit

2 Installation

The required IssueNet software components are installed as an optional component of the IssueNet Suite installation package. The components are installed by default during a complete installation but can also be selected or unselected during a custom installation or modification of an existing installation. Note:- If you do not want to run the IssueNet Installation package on a different server, you can copy the required files from another computer on which IssueNet has been installed to the server.

The integration components are installed to the following sub-directory structure of the IssueNet installation directory. The default location is: C:\Program Files\Elsinore Technologies\IssueNet\Integrations\SourceControl. In addition to this readme, the following files are installed:

  • Elsinore.SourceControlService.exe.config - configuration file for integration options
  • Elsinore.SourceControlService.exe.config.sample - sample configuration file demonstrating configuration options for different systems

The following support files will need to be copied from the C:\Program Files\Elsinore Technologies\IssueNet\Assemblies directory into the directory from which the Elsinore.SourceControlService.exe is running:

  • Elsinore.Core.dll - core IssueNet platform component.
  • Elsinore.Engine.dll - core IssueNet platform component.
  • Elsinore.MMFWebClient.dll - core IssueNet platform component.
  • Elsinore.SQLClientEngine.dll - core IssueNet platform component.
  • Elsinore.SCM.dll - IssueNet Intercept solution plug-in.
  • ICSharpCode.SharpZipLib.dll – supporting component for IssueNet web services.

*Note: in versions 5.4 and higher, these files are in the assemblies directory

Once the files are in place, the IssueNet Source Control Integrator service can be installed. The install utility distributed with the Microsoft .NET Framework is used to install or uninstall the service. The “net” utility included with Microsoft Windows can be used to start or stop the service. The service can also be managed through the “Services” utility in the “Administrative Tools” section of the Windows control panel.

To install:
C:\Windows\Microsoft.NET\Framework\v2.0.50727\installutil.exe /i “C:\Program Files\Elsinore Technologies\IssueNet\Assemblies\Elsinore.SourceControlService.exe”

To uninstall:
C:\Windows\Microsoft.NET\Framework\v2.0.50727\installutil.exe /u “CC:\Program Files\Elsinore Technologies\IssueNet\Assemblies\Elsinore.SourceControlService.exe”

To start:
net start “IssueNet Source Control Integrator”

To stop:
net stop “IssueNet Source Control Integrator”

Edit

3 Configuration

The Source Control Integrator service is configured through the Elsinore.SourceControlService.exe.config file. The Elsinore.SourceControlService.exe.config.sample file provides a sample for each type of source control system. We suggest cutting and pasting the appropriate sections from the sample file to the configuration file to get started.

The IssueNetConnectionName elements in configuration file reference connections defined on the server.There are two ways to define IssueNet connection profiles on the server:

  1. Copy an IssueNet connections.xml and datasources.xml from a computer which has the desired connection profiles and place them in the directory with the other integration files. The connections.xml and datasources.xml are typically located in the C:\Documents and Settings\All Users\Application Data\Elsinore Technologies directory.

  1. Perform an IssueNet client or server installation on the source code control server and define the necessary connection profiles using a client application such as the IssueNet Manager.

Edit

4 Using the Integration

The integration is used by including commands in source control comments. The commands follow a syntax specifying a TaskID and an optional TransitionName. In all cases a SourceCodeChangeset is linked to the SoftwareTask specified by the TaskID. The SourceCodeChangeset includes details, often specific to the source control system, about the changeset. The TransitionName can be used to automatically execute a workflow transition on the SoftwareTask. The default syntax for comments is “(#TaskID:TransitionName)”, an example being “(#1234: Ready for Build)”.