Configuring the Microsoft Team Foundation Server integration plug-in
After the Microsoft Team Foundation Server (TFS) source control provider is added to Helix ALM, a TFS administrative user needs to install and configure the integration plug-in to exchange attachment information between the Team Foundation Server and Helix ALM
1. Check the supported TFS versions and download the plug-in.
2. Copy the contents of the plug-in zip file to the Application Tier\Web Services\bin\Plugins directory in the TFS application directory (e.g., C:\Program Files\Microsoft Team Foundation Server <version>\Application Tier\Web Services\bin\Plugins).
3. Open TTTFSPluginServer.dll.config in a text editor.
4. Update the following values in the file.
Value | Description |
---|---|
ProviderKey | Key from the source control provider configured in the Helix ALM project. See Adding Microsoft Team Foundation Server source control providers. |
TTExtProCGIURL | URL to the Helix ALM source control provider CGI (e.g., http://localhost/scripts/ttextpro.exe). If you need to install the CGI, see the installation help for information. |
IssueTag, TestCaseTag, and RequirementTag | Helix ALM item tags that identify item types in check in comments. The default tags are IS for issues, TC for test cases, and RQ for requirements. You can use different tags if item types are renamed. |
AllowCheckinIfErrors | True allows changes to be checked in to TFS even if an
error that prevented attaching files to the Helix ALM item occurred. To prevent
TFS check ins when errors occur, change the value to false. If TFS project templates are configured to automatically check in files when new projects are created, setting the value to false could cause errors that prevent users from creating new projects. To allow check in of new projects created from these templates, set the value to true. |
RequiredAttachmentFileExtensions | Extensions of file types that must be attached to Helix ALM items when checked in. Only applies if AllowCheckinIfErrors is set to false. Use an asterisk to separate extensions (e.g., "*.cpp *.h"). |
5. Save the configuration file.
After the plug-in is configured, provide users with the item tags from the configuration file so they can include them in TFS check in comments to attach files to Helix ALM. See Attaching Git, GitHub, and Team Foundation Server files to items.