Prerequisite

The Integration Pack for Microsoft Team Foundation Server 2010 (TFS IP) is developed using Opalis Quick Integration Kit (QIK).  Therefore, .NET framework 3.5 has to be installed.  In addition, dependencies of TFS 2010 DLL's need to be in the Global Assembly Cache (GAC) by either:

• Install Visual Studio 2010 any version with Team Explorer, OR
• Find a machine installed with above product, copy all files at %ProgramFiles (x86)%\Microsoft Visual Studio 10.0\Common7\IDE\ReferenceAssemblies\v2.0 to GAC using gacutil.exe (in Visual Studio 2010 or Windows platform SDK) or File Explorer (drag and drop to %windir%\Assembly).

The TFS IP is designed to work on both domain-joined trusted network or private machines in a workgroup.  Before using the IP, make sure the correct TFS server URL has been got from the sys admin, e.g. "http://scxtfs2:8080/tfs".

Installation

1. Copy TFS 2010 assemblies shown in previous section to both the Designer Client and the Runbook Server (previously known as “Action Server”) machines.
2. Download the latest version of the IP.
3. Register the IP on the Management Server.
4. Deploy the IP on the Runbook Server and the Designer Client.

Configuration

The prerequisite configuration for the IP can be accessed by Team Foundation Server on the Options menu. The Type of the configuration is "TFS Connection Settings".

• Team Foundation Server URL: for instance "http://scxtfs2:8080/tfs".
• Logon domain (RunAs), User name (RunAs), Password (RunAs): if the credential used to access the TFS is not the service account which is used to run the Runbook Server, one can use this setting to impersonate another user. For example, the machine is in corpnet, the logon user for the Runbook Server is REDMOND\scxsvc, but we want to use REDMOND\zhyao to query/file bugs, we will enter "REDMOND", "zhyao" and "(password here)" in the settings. This should work for cross-domain scenario as well.

Another way to pass the credential: if the Runbook Server machine is not in the same domain of the TFS access credential, for instance accessing http://scxtfs2:8080/tfs in REDMOND domain using SCX\scxsvc in untrusted SCX.COM domain, leave domain/username/password empty to disable the impersonation and add the access credential to the system by:

   cmdkey /add:scxtfs2 /user:REDMOND\zhyao /pass:PasswordOfZhyao

Then the code will automatically use this credential upon connecting to TFS server.

Activities for work item tracking

Get Work Item

This activity retrieves detailed information of a work item by ID, which can be a Bug, User Story, Task, Test Case, etc. The published data is a subset of WorkItem object information.

Parameters

Published data

Predefined error conditions

• Work item ID is equal to or less than zero.
• Work Item is not found on the server.

Query Work Items

This activity queries the server using the Work Item Query Language (WIQL). For more information about WIQL, refer to MSDN document at http://msdn.microsoft.com/en-us/library/bb130306(v=VS.100).aspx. For instance, to query all the test cases across all projects,

select * from WorkItems where [Work Item Type]='Test Case'

Although it is straightforward to write the query, there is another way to create WIQL using Visual Studio.

1. Create a query using Visual Studio.
2. Save the file on the disk, for instance abc.wiq.
3. Rename the file to abc.xml
4. Open the file using IE.
5. Here is WIQL

Note that the WIQL from a saved query is parameterized and some of the parameters (“@project” for example) will have to be edited before the WIQL can be run in the IP.

Parameters

Published data

Note that some published data in Get Work Item are not available in this activity.

Predefined error conditions

• Work Item Query string is empty.
• Failed to query.

Set Work Item

This activity changes the fields or states of a work item. Resolving bugs, closing tasks and so on can be performed using this activity.

Parameters

Published data

Same as “Get Work Item”.

Predefined error conditions

• Work Item ID is equal to or less than zero.
• Custom Field Name cannot be found in the fields of the work item.
• Failed to query the work item.

New Work Item

This activity creates a new work item, such as Bug, Test Case, User Story, or Task.

Parameters

Published data

Same as “Get Work Item”.

Predefined error conditions

• Work Item ID is equal to or less than zero.
• Custom Field Name cannot be found in the fields of the work item.
• Failed to query the work item.
• Some fields have invalid values. In this case, those field will be listed along with their values.

Monitor Work Items Query

This activity periodically poll the work item store using the given Work Item Query and triggers when the number of query result changes. It uses WorkItemStore.QueryCount method and theoretically consumes less amount of resource than WorkItem.Query.

Parameters

Published data

Activities for version control

List Version Control Items

This activity lists all items (files and folders) on the version control server under the given folder recursively or non-recursively. No workspace is needed for running this activity.

Parameters

Published data

Predefined error conditions

• Version Control Server Path is empty.

Download File

This activity downloads a file from the version control server to the local machine directly. No workspace is needed.

Parameters

Published data

None.

Update Workspace

This activity updates the workspace on the local machine to the latest version and reports number of items being updated, etc. Note that a workspace needs to be created before running this activity.

Parameters

Published data

Check Out

This activity checks out an item recursively or non-recursively for editing, deleting, or adding. Note that a workspace needs to be created before running this activity.

Parameters

Published data

None

Check In

This activity checks in the pending changes in the local workspace recursively or non-recursively. Note that a workspace needs to be created before running this activity.

Parameters

Published data

None

Get Changeset

This activity retrieves details of a changeset.

Parameters

Published data

Items marked with "*" will be grouped as an Object if multiple build definitions are returned.

Activities for Team Build

Get Build Definitions

This activity retrieves all the build definitions for a given team project.

Parameters

Published data

Items marked with "*" will be grouped as an Object if multiple build definitions are returned.

Get Build Details

This activity retrieves all builds for the given build definition on the team project.

Parameters

Published data

Items marked "*" will be grouped as an Object if multiple builds are returned.

Request Build

This activity requests a new build and puts it in the queue for a given build definition on a team project.

Parameters

Published data

Set Build Details

This activity changes the properties of existing build details.

Parameters

Published data

Same as published data for “Get Build Details”.

Monitor Build

This activity monitors queued builds and triggers when the status is changing or changed. When it is executed, all build details which status is InProgress will be retrieved and handlers will be set to capture the status changed/changing events. If no build is in progress (i.e. all are completed, or the queue is empty), the activity will wait for 10 seconds and query again.

Parameters

Published data

Logging

Instead of using TraceLogger, Team Foundation Server IP uses the standard Event Tracing for Windows for the logging. Here is the list of parameters:

• Provider GUID: {2FAF39E7-673B-4D89-BB89-E2CDADE0EA13}
• Listener Name: TeamFoundationServerIP Listener
• Provider Name: TeamFoundationServerIPProvider

One can

either use logman or netsh to collect the ETW logs. For instance:

Create trace:

   logman create trace TFSIP -o %windir%\Temp\TFSIP -p "{2FAF39E7-673B-4D89-BB89-E2CDADE0EA13}”

Start tracing:

   logman start TFSIP

Stop tracing:

   logman stop TFSIP

*.ETL saved at %windir%\TEMP can then be opened using XPerf or converted to XML using tracerpt:

   tracerpt -o out.xml -of xml %windir%\Temp\TFSIP_00001.etl

For more information on logman, refer to TechNet document at http://technet.microsoft.com/en-us/library/bb490956.aspx.