softwareplanner connector for

This document is your guide for connecting data in

SoftwarePlanner with other software solutions.

User’s Guide

SoftwarePlanner Connector for Microsoft Team Foundation Server (TFS) Source System

TFS Integrator User’s Guide All SoftwarePlanner Editions

1

Contents Understanding the Integrator Capabilities ............................................................................................. 2

Narrative ............................................................................................................................................. 2

What artifacts can be synced? ............................................................................................................ 2

What are the software and hardware requirements? ........................................................................ 3

How much does it cost? ...................................................................................................................... 4

Installation Instructions .......................................................................................................................... 5

How do I get started? .......................................................................................................................... 5

Can OpsHub do the Installation and Configuration for Us?............................................................ 5

Setting up your TFS Proxy ............................................................................................................... 5

Configuring the SoftwarePlanner SCM Name ..................................................................................... 6

Configuring the Integration using the OpsHub OIM Manager ........................................................... 6

Installation Instructions for TFS Source Control Item to SmartBear Direct ............................................ 7

Configuring System Configuration - TFS Source System [TFS Source to SmartBear Direct] ........... 7

Create Workflow [TFS Source to SmartBear Direct] ....................................................................... 8

Create Field Mapping [TFS Source to SmartBear Direct] ................................................................ 8

Create Integration [TFS Source to SmartBear Direct] ..................................................................... 9

Installation Instructions for TFS Source Control Item to TFS Item........................................................ 12

Configuring System Configuration - TFS Source System [TFS Source to TFS Item] ....................... 12

Create Workflow [TFS Source to TFS Item] ................................................................................... 13

Create Field Mapping [TFS Source to TFS Item] ............................................................................ 13

Create Integration [TFS Source to TFS Item] ................................................................................. 14

Installation Instructions for TFS Source Control Hook .......................................................................... 16

Configure TFS Hook ....................................................................................................................... 16

Enable OpsHub Check In Policy (TFS Client) ................................................................................. 17

Usage Instructions for TFS Source Control Commit .............................................................................. 18

Checking TFS Source Item In (TFS Source Code to TFS Work Item) .............................................. 19

Checking TFS Source Item In (TFS Source Code to SoftwarePlanner Direct) ................................ 19


2

Understanding the Integrator Capabilities

Narrative We understand that not all teams can standardize all artifacts of their software lifecycle using

SoftwarePlanner so we’ve partnered with OpsHub (http://www.OpsHub.com) to bring you state-of-

the-art integrators that allow you to connect data in Microsoft Team Foundation Server (TFS) with

SoftwarePlanner. This strategy allows team members to use the tool they are most comfortable

with while synchronizing data stored in their tool of choice with SoftwarePlanner.

This integration works with the following editions of SoftwarePlanner:

QAComplete – SaaS or Enterprise

DevComplete – SaaS or Enterprise

ALMComplete – SaaS or Enterprise

What artifacts can be synced? This connector can synchronize these artifacts:

TFS Source Code Control Item to TFS Work Item (then to SoftwarePlanner traceability) Movie: http://www.softwareplanner.com/Movies.asp?Topic=OpsHub_SCM

TFS Source Code Control to SmartBear Item Traceability Movie: http://www.softwareplanner.com/Movies.asp?Topic=OpsHub_SCM

SCM Integration The connector can synchronize source code with artifacts in TFS or directly to SoftwarePlanner. For

example, you may want to associate requirements or defects with source code. When associating

source code, you have 2 modes of operation:

1. If you are using TFS as your primary defect tracking system (and synching those to

SoftwarePlanner), as you check in source code, you can link that source code to TFS

defects. When the defect is synced to SoftwarePlanner, it will link the file to the

SoftwarePlanner item using traceability in the Linked Items section. If you are planning

this type of integration you must still set the TFS synchronization for the TFS work item to

the Software Planner item as detailed in the TFS setup guide, download it here:

http://www.softwareplanner.com/UsersGuide_TFS.pdf.

2. If you are using SoftwarePlanner as your primary defect tracking system (and not synching

those to TFS), you can associate source code with SoftwarePlanner defects and they show

http://www.opshub.com/

http://www.opshub.com/

http://www.softwareplanner.com/Movies.asp?Topic=OpsHub_SCM

http://www.softwareplanner.com/Movies.asp?Topic=OpsHub_SCM

http://www.softwareplanner.com/UsersGuide_TFS_SCM.pdf


3

up in the traceability section of SoftwarePlanner:

What are the software and hardware requirements? To use this connector, you must have the following hardware and software (it installs on either

Windows or Linux):

Microsoft TFS 2010

ALMComplete, QAComplete or DevComplete version 9.5 or higher

Windows: Windows XP, Windows Vista, Windows 7 running IIS

Or if using Linux: Red Hat Linux

Java 6 (JDK 1.6)

Memory: 512mb minimum, 2gb recommended

Databases Supported: Mysyql Server with innodb (version 5.1+), Oracle 10g Release 2+, Microsoft SQL Server 2008 R2+, Microsoft SQL Server 2005

Database Connectors Supported: Mysql Connector/J (JDBC Driver version 5.0+), Oracle JDBC Driver (version 10.2.0.4.0), MS SQL Connector (version sqljdbc_3.0)


4

How much does it cost? If you purchased SoftwarePlanner (ALMComplete, QAComplete or DevComplete edition) after

November 1, 2010, you receive a certain number of integration modules at no cost. An

integration module is a distinct entity (defects, requirements, source control). The number of

integration modules you receive at no cost depends on how many licenses of SoftwarePlanner

you purchased:

0 – 25 users – up to 1 integration module included at no cost

26 – 50 users – up to 2 integration modules included at no cost

51 – 75 users – up to 3 integration modules included at no cost

76 – 100 users - up to 4 integration modules included at no cost

101+ Users – up to 5 integration modules at no cost If you purchased SoftwarePlanner prior to November 1, 2010, the cost of the first integration

module is 15% of your original SoftwarePlanner purchase price.

If you need to purchase additional integration modules (after your first), they are available for 6%

of your original SoftwarePlanner purchase price.


5

Installation Instructions

How do I get started? To get started, you will follow these steps:

1. Watch the movies in the “What artifacts can be synced?” section to see how the

integration works.

2. Download and install the OpsHub connector (Windows or Linux) here:

http://www.softwareplanner.com/downloads/OpsHubDownload.asp

3. Configure your TFS Proxy, see the “TFS Proxy Configuration” section for more details.

4. Determine if you want to setup an integration that is "TFS Source to Software Planner

Direct" or is a "TFS Source to TFS Bug" configuration and follow the configuration

instructions.

5. Optionally, configure the "TFS Source Hook" for additional validation when checking in

source code with OpsHub enabled integrations.

Can OpsHub do the Installation and Configuration for Us?

Yes, if you prefer to have OpsHub do it instead, their Professional Services team can install, configure

and/or customizing the mappings. To get started with that, they will need to know what integration

modules you wish to configure, custom rules for integration, and any additional required mappings.

Once they have this information, they can provide you with a fixed price estimate. Email your

request for this to Sandeep Jain [email protected] or call him directly at +1 650.743.7361.

Setting up your TFS Proxy

The OpsHub OIM manager requires a special proxy to be placed in front of the TFS web services.

This acts as a translation layer between TFS and OpsHub and must be configured for the TFS

connector to work. This assumes that you are installing and configuring this on a machine that has

IIS and .NET 2.0 installed. Note that this is the same step as required by the item synchronization

between TFS and SoftwarePlanner and if you have already performed this it is not necessary to

repeat.

1. Locate the TFSWorkItemWebService folder in the installation package and copy it to your

IIS location (e.g. copy entire folder to C:\Inetpub\wwwroot\TFSWorkItemWebService).

2. Edit the web.config file and change the path to be a valid path that has appropriate write

security for logging. For example, we will save logs to the C:\logs\ folder so the setting

will look like this: '<param name="File" value="C:\logs\OpsHubProxyLog.txt" />'.

3. Edit the web.config file and add the <trust level="Full" /> to the <system.web> section.

4. In IIS Manager, make the TFSWorkItemWebService folder an application.

5. Test the web service by opening the web service TFSWorkItemWebService.asmx file in IIS

using the browse option in the content view or open it in a browser. Invoke the "Test"

method and you should see '<string>WebService Call was success.</string>'.

http://www.softwareplanner.com/downloads/OpsHubDownload.asp

mailto:[email protected]


6

Configuring the SoftwarePlanner SCM Name You can configure the SoftwarePlanner Source Code Management name that is used for the project

so that the display name will represent the actual system in use.

1. Log in to SoftwarePlanner.

2. Navigate to the Setup tab.

3. Select the System Configuation | System Options menu in the Navigation window.

4. Set Your Source Code Management Name to 'TFS'.

Configuring the Integration using the OpsHub OIM Manager The OpsHub OIM manager should be installed using the install package supplied. Be sure to follow

all instructions included in the installation document. Once OpsHub has been installed and

configured, be sure to start the OpsHub application by navigating to the All Programs | OpsHub

Application | Start OpsHub Server menu item in the Start menu. If it is running you should see a

command window spin up and it will remain open all the time. There is also an option to register

OpsHub as a service while installation to avoid a window all time open. Now, you can navigate to the

OpsHub OIM web based management software by following these steps.

1. Open a browser and navigate to http://localhost:8989/OpsHubWS/ NOTE: The OpsHubWS is case-sensitive and it is recommended you use FireFox or IE7 for this.

http://localhost:8989/OpsHubWS/


7

2. Type in 'admin' for the user and 'password' for the corresponding password. 3. The OpsHub manager will be displayed.

Movie: Watch this movie to get an overview of the OpsHub OIM Manager:

http://www.softwareplanner.com/Movies.asp?Topic=OpsHub_OIM

Installation Instructions for TFS Source Control Item to SmartBear

Direct

This connector scenario does not require that you set up any custom fields for OpsHub and is used

when you do not want to sync TFS items to SoftwarePlanner items and instead want to use TFS

Source Code control to link commits to defects or requirements in SoftwarePlanner for traceability.

This scenario can be configured to run with any SoftwarePlanner artifact and this installation will

support traceability to all items including Defects, Requirements, and Test Cases.

Configuring System Configuration - TFS Source System [TFS Source to SmartBear Direct]

Before setting up any integrations or workflows in the OpsHub manager we need to create the

systems that will be utilized in our process and mappings. We will be setting up one for TFS and one

for SmartBear. The System Configuration panel is located in the Administration tab in the OpsHub

OIM web manager.

1. Log in to the OpsHub OIM Manager (see prior topic).

2. Select the 'Create System' menu option and select 'TFS Source System' from the

dropdown.

3. Set System Name to 'tfsSourceSystem'.

4. Set Version to '2010'.

5. Select the blue right arrow ( ) next to Template and be sure to check issueid_str, and

reviewer_usr and set the Attribute Display Name and User System Name as follows:

NOTE: If you do not see the attribute name, you will need to add the attribute exactly as

shown above using the "Create Attribute" menu item in OpsHub OIM.

6. Leave ALM System set to 'Select'.

7. Set Project Path Separator to '/'.

8. Leave Entity Type blank.

9. Set Enable OIM to 'Yes'.




8

10. Set TFS WebService URL to

'http://[YourTFSMachineName]/TFSWorkItemWebService/TFSWorkItemWebService.asmx

'. NOTE: This will vary by where you have installed your TFS web service proxy.

11. Set TFS Server URL to 'http:// [YourTFSMachineName]/tfs'.

NOTE: This will vary by where you have installed your TFS server.

12. Set TFS User Name, TFS User Password, and TFS User Domain to the user that you want

to authenticate and use for sync.

13. Set TFS Team Collection Name to the text value of the collection where the project

resides that is used in the sync (e.g. 'DefaultCollection').

14. Set TFS Project Name to the project name that is to be used in the sync.

Create Workflow [TFS Source to SmartBear Direct]

The OpsHub connector requires workflow mappings to be configured. The SmartBear installation

provides some default workflow mappings and these are installed and saved in the

doc\Workflow folder. For this example we will install the SmartBear SCM Defects Traceability

workflow item which is the direct from TFS to SoftwarePlanner scenario.

1. Log in to the OpsHub OIM Manager.

2. Select the 'Workflow Upload' menu option in the OIM Configuration tab.

3. Create a name that is descriptive (recommended to use the same name as the file that

is selected)

4. Optionally, add a description.

5. Select the 'Browse...' button and select the process definition file (e.g. 'SmartBear SCM

Defects Traceability.xml').

6. Next, press the 'Upload' button.

7. Select the Systems that are to be used in this workflow. In this case it is SmartBear and

TFS Source. NOTE: Use the CTRL key and left click on each system to select more than

one item.

8. Click on the 'Save' button.

9. If you are using requirements (SmartBear SCM FunctionalSpec Traceability) or test

cases (SmartBear SCM TestCase Traceability) and want to enable commits to those

repeat the above steps for the appropriate workflow.

Create Field Mapping [TFS Source to SmartBear Direct]

The OpsHub connector requires field mappings to be configured. The SmartBear installation

provides some default field mappings and these are installed and saved in the \Mappings folder. For

this example we will install the SmartBear-TFS SCM Bug Traceability field mapping.



9

2. Select the 'Field Mapping Upload' menu option in the OIM Configuration tab.

3. Create a name that is descriptive (recommended to use the same name as the file that is

selected)


5. Select the 'Browse...' button and select the mapping file (e.g. ' SmartBear-TFS SCM Bug

Traceability.xsl').



8. Edit the field mapping that you just uploaded and modify the default mapping to change

the location of the TFS path to reflect the correct URL to your TFS repository.

9. If you are using requirements (SmartBear-TFS SCM FunctionalSpec Traceability) or test

cases (SmartBear-TFS SCM TestCase Traceability) and want to enable commits to those

repeat the above steps for the appropriate field mapping.

Create Integration [TFS Source to SmartBear Direct]

The OpsHub connector requires an integration that will tie the field mappings and workflow

together on a set schedule. For this example we will configure the SmartBear SCM Traceability that

will utilize the create and update workflows and corresponding field mappings.


2. Select the 'Create Integration' menu option in the OIM Configuration tab.

3. Create a name that is descriptive (recommended to use a similar name to the integration

we are doing such as 'TFS Source to SmartBear SCM Traceability'.

4. Select the Source System. This will be determined by which system is the source system

and is usually indicated by the first system name in the process workflows (in our case this

is TFS Source to SP Direct).

5. Set Sync to 'Both'.

6. Set Source System Entity Type to 'TFS Commit Information'.

7. Set Start Processing Event Id to the checked in changeset Id from where the Integration

will start.

8. Leave OpsHub Template Parser Action Id blank.

9. Set Maximum Retry Count to '3'.

10. Set Associate Schedule to a polling time that you are comfortable with. For this example we have selected 1 minute.

11. Next, for the sync action, select the 'Add WorkFlow' link.

12. Set the Workflow to the corresponding workflows (in our case it is the three workflows).

13. Set the Field Mapping to the corresponding field mapping (in our case it is the three field

mappings).

14. Select the 'Set Parameter' link and the Workflow Configuration Parameter screen should

be displayed.


10

15. Select the SmartBear Project Name, in which the entities will be synchronized.

16. Set the Software Planner Entity Type to 'Software Planner Defect'.

17. Next, press the 'Submit' button.

18. Press the 'Save' button.

19. Repeat steps 11-18 for requirements and test cases (be sure to select the correct entity

type on the Set Parameter screen).

20. Press the 'Submit' button on the Create Integration screen.

NOTE: If you do not press the submit button on this page the integration will be lost.

21. The final step is to make sure it is Active. On the 'View OIM Integrations' screen select

the down arrow next to the Edit button and select the 'Active' option.


11


12

Installation Instructions for TFS Source Control Item to TFS Item

This connector scenario is applicable when you are syncing TFS work items to Software Planner

items and want to have traceability of TFS source code commits inside Software Planner to linked

items. If you are planning this type of integration you must still set the TFS synchronization for the

TFS work item to the Software Planner item as detailed in the TFS setup guide, download it here:

http://www.softwareplanner.com/UsersGuide_TFS.pdf. This scenario can work with any artifact but

each artifact must be configured individually. For our installation, we will work with TFS Source

Code to TFS Bugs and this assumes you have already completed the integration for TFS Bugs to

SmartBear Defects.

Configuring System Configuration - TFS Source System [TFS Source to TFS Item]

Before setting up any integrations or workflows in the OpsHub manager we need to create the

systems that will be utilized in our process and mappings. We will be setting up one for TFS and one

for SmartBear. The System Configuration panel is located in the Administration tab in the OpsHub

OIM web manager.

1. Log in to the OpsHub OIM Manager (see prior topic).

2. Select the 'Create System' menu option and select 'TFS Source System' from the

dropdown.

3. Set System Name to 'tfsSourceSystem'.

4. Set Version to '2010'.

5. Select the blue right arrow ( ) next to Template and be sure to check EntityType,

issueid_str, and reviewer_usr and set the Attribute Display Name and User System Name

as follows. NOTE: The EntityType should only be set if you are going direct from TFS to a

SoftwarePlanner entity.

6. Leave ALM System set to 'Select'.

7. Set Project Path Separator to '/'.

8. Leave Entity Type blank.

9. Set Enable OIM to 'Yes'.





13

10. Set TFS WebService URL to

'http://[YourTFSMachineName]/TFSWorkItemWebService/TFSWorkItemWebService.asmx

'. NOTE: This will vary by where you have installed your TFS web service proxy.

11. Set TFS Server URL to 'http:// [YourTFSMachineName]/tfs'.

NOTE: This will vary by where you have installed your TFS server.

12. Set TFS User Name, TFS User Password, and TFS User Domain to the user that you want

to authenticate and use for sync.

13. Set TFS Team Collection Name to the text value of the collection where the project

resides that is used in the sync (e.g. 'DefaultCollection').

14. Set TFS Project Name to the project name that is to be used in the sync.

Create Workflow [TFS Source to TFS Item]

The OpsHub connector requires workflow mappings to be configured. The SmartBear installation

provides some default workflow mappings and these are installed and saved in the

doc/Workflow/Custom /SmartBear_SCM folder. For this example we will install the SmartBear-TFS

SCM Traceability workflow item which is the direct from TFS to SoftwarePlanner scenario.


2. Select the 'Workflow Upload' menu option in the OIM Configuration tab.

3. Create a name that is descriptive


5. Select the 'Browse...' button and select the process definition file


7. Select the Systems that are to be used in this workflow. In this case select SmartBear and

Team Foundation Server. NOTE: Use the CTRL key and left click on each system to select

more than one item.


Create Field Mapping [TFS Source to TFS Item]

The OpsHub connector requires field mappings to be configured. The SmartBear installation

provides some default field mappings and these are installed and saved in the

doc/SmartBearMappings/SmartBear_SCM folder. For this example we will install the SmartBear-

TFS SCM Traceability field mapping.


2. Select the 'Field Mapping Upload' menu option in the OIM Configuration tab.

3. Create a name that is descriptive


5. Select the 'Browse...' button and select the process definition file




14

Create Integration [TFS Source to TFS Item]

The OpsHub connector requires an integration that will tie the field mappings and workflow

together on a set schedule. For this example we will configure the TFS Source to Defects

Traceability that will utilize the create and update workflows and corresponding field mappings.


2. Select the 'Create Integration' menu option in the OIM Configuration tab.

3. Create a name that is descriptive (recommended to use a similar name to the integration

we are doing such as 'TFS Source to Defects SCM Traceability'.

4. Select the Source System. This will be determined by which system is the source system

and is usually indicated by the first system name in the process workflows (in our case this

is TFS Source).

5. Set Sync to 'Both'.

6. Set Source System Entity Type to 'TFS Commit Information'.

7. Set Start Processing Event Id to the checked in changeset Id from where the Integration

will start.

8. Leave OpsHub Template Parser Action Id blank.

9. Set Maximum Retry Count to '3'.

10. Set Associate Schedule to a polling time that you are comfortable with. For this example

we have selected 1 minute.


15

11. Next, for the sync action, select the 'Add Mapping, WorkFlow' link.

12. Set the Workflow to the corresponding workflow (in our case it is SmartBear SCM

Traceability).

13. Set the Field Mapping to the corresponding field mapping (in our case it is SmartBear-TFS

SCM Traceability).

14. Select the 'Set Parameter' link and the Workflow Configuration Parameter screen should

be displayed.

15. Select the SmartBear Project Name, in which the entities will be synchronized.

16. Set Software Planner Entity Type (SmartBear) to 'Software Planner Defect'.

17. Set Team Foundation Server Entity Type (Team Foundation Server) to 'TFS Defect'.

18. Next, press the 'Submit' button.

19. Press the 'Save' button.

20. Press the 'Submit' button on the Create Integration screen.

NOTE: If you do not press the submit button on this page the integration will be lost.


16

21. The final step is to make sure it is Active. On the 'View OIM Integrations' screen select

the down arrow next to the Edit button and select the 'Active' option.

Installation Instructions for TFS Source Control Hook

The OpsHub integration requires that comments be entered in a certain format in order for them to

properly link up to the associated item. An optional TFS Hook can be utilized to ensure that more

accurate data is submitted by the user in the comments field when a commit is performed. The

setup is a two step process with the first step registering the hook on the TFS Server and the second

adding the policy to the TFS client. The TFS hook can be found at

http://www.opshub.com/ohftp/TFSHook_R2011Q2B004.zip

Configure TFS Hook

Log on to your TFS Server and follow these steps to complete this installation. The TFS Hook is in the

\hook folder.

1. Locate the 'property_sample.txt' file and rename it to 'property.txt'.

2. Modify the property.txt file and change the appropriate settings:

url: This is the URL of the OpsHub server (e.g.

http://opshubclient:8989/OpsHubWS/services/CommitVerify?wsdl)

CompanyId: This should be left at '1'.

username: This should be 'admin'.

password: This should be 'password'.

repositoryId: This is the OpsHub system Id that will be used for this hook. You can find

that in the OpsHub SQL Server database in the opshub.OHMT_C_systems table.

commitOnConnectionFailure: This should be set to 'False'.

NOTE: If you set this to 'True' it will let the commit happen even if not valid.


17

3. Create a new folder called opshub in the \Microsoft Team Foundation Server

2010\Application Tier\Web Services\ folder.

4. Copy the property.txt file to this new folder.

5. Open Internet Information Services (IIS).

6. Open the Sites and then the 'Team Foundation Server' website. Expand it and select the

'tfs' application.

7. Select the 'opshub' folder and select 'Authentication'. Set Anonymous and Basic

Authentication to enabled, all others should be disabled.

Enable OpsHub Check In Policy (TFS Client)

Log on to your TFS client machine where you will be making source code commits. The policy files

that will be required are located in the http://www.opshub.com/ohftp/TFSHook_R2011Q2B004.zip

download.

1. Create a folder on your local machine where the TFS Hook can be saved on your machine

(e.g. C:\OpsHub\TFSHook\).

2. Locate the 'OpsHubTFSHook.dll' file and copy it to the location in step 1.

3. Next, open the registry editor and locate the \TeamFoundation\SourceControl\Checkin

Policies registry hive.

NOTE: The easiest way to find this may be to search for

'Microsoft.TeamFoundation.Build.Controls'.

4. Create a new registry entry called 'OpsHubTFSHook'. The value should be the full path

and filename to the OpsHubTFSHook.dll file (e.g.

C:\OpsHub\TFSHook\dll\OpsHubTFSHook.dll).


18

5. Now, register the new check in policy with your TFS client by opening Visual Studio.

6. Open the TFS Project you want to assign this policy to.

7. Right-click and on the project and select Team Project Settings -> Source Control.

8. Select Check-in Policy tab.

9. Click on the Add... button.

10. Find the 'OpsHub Checkin Policy' in the list and select it, press OK.

11. Press OK to save the changes.

Usage Instructions for TFS Source Control Commit

Once you have the necessary installation items completed you are now ready to commit source code

files to TFS and have them show up in SoftwarePlanner traceability. This process will require you to

use a template when you perform the commit so that OpsHub knows how to connect the file to the

appropriate artifact. This process is very similar whether you are committing to TFS work items or

directly to Software Planner items.


19

Checking TFS Source Item In (TFS Source Code to TFS Work Item)

In the TFS project that you have configured in the integration, check in a file that is ready for a

commit due to a change regarding a fix to a defect or change based on a requirement. Follow these

steps to properly link the TFS commit to SoftwarePlanner traceability. This method will add a

traceability link for the file inside SoftwarePlanner once the synchronization with the corresponding

bug occurs. NOTE: This will not create a link in TFS, you still need to select the corresponding work

item on the Work Items screen for this to work properly.

1. Select the file(s) to check in and start the TFS Check In procedure either in Visual Studio or through Windows Explorer.

2. In the Comment enter the following tokens:

NOTE: The tokens must be typed exactly as seen or they will not properly sync up to

SoftwarePlanner. The IssueId is the TFS Work Item Id.

Checking TFS Source Item In (TFS Source Code to SoftwarePlanner Direct)

In the TFS project that you have configured in the integration, check in a file that is ready for a

commit due to a change regarding a fix to a defect or change based on a requirement. Follow these

steps to properly link the TFS commit to SoftwarePlanner traceability.

1. Select the file(s) to check in and start the TFS Check In procedure either in Visual Studio or through Windows Explorer.


20

2. If associating source control with a defect, requirement or test case inside of Software

Planner, in the Comment enter the following tokens: D::[Defect ID from Software Planner] (e.g. D::12345) -or- R::[Requirement ID from Software Planner] (e.g. R::12344) -or- T::[Test Case ID from Software Planner] (e.g. T::455665)

3. If associating source control with a TFS work item, in the Comment enter the following tokens: IssueId::[TFS Work Item ID] (e.g. IssueId::50) Reviewer::[TFS Reviewer] (e.g. Reviewer::Steve Johnson, this is optional) Comments::Any comments can go here, this is optional.

softwareplanner connector for

Documents