Microsoft Team Foundation Server / Visual Studio Team Services

Technical requirements

The following requirements must be met to integrate TFS/VSTS with SD Elements.

  • NTLM or Basic Authentication must be enabled

  • The user configured for the connection should:

    • Be a member of the project

    • Have permission to create, tag, transition and close work items.

    • Specific permissions:

      • Edit project-level information - Allow

      • Create tag definition - Allow

Default assigned fields

The following fields are set by default:

  • Title

  • Description

  • Priority

Behavior

The integration supports the following:

Connection details

Enter the connection details for the server.

Protocol

Select the protocol for the connection (HTTPS or HTTP) (Default: HTTPS)

Server

The domain name or IP address of the server

Context Root

Top-level location where TFS/VSTS is installed on a server. The value for this may be dependent on the configuration of an internal corporate proxy or where an administrator has installed TFS/VSTS.

Collection name

The name of a project collection in TFS/VSTS (Default: DefaultCollection)

Credentials

Enter the credentials needed to authenticate to the server.

Username

Username authorized to connect with the server and create/edit issues in anticipated projects.

Password or Personal Access Token (PAT)

User password or PAT

Project details

Enter the project-level details.

TFS Project

The name of the project where issues should be created.

Advanced TFS/VSTS configuration

Enter advanced configuration options.

Issue Type

Type of issue that SD Elements will create when creating a task in TFS/VSTS. (Default: User Story)

Open a story in TFS with the following status

Status to assign to new issues (Default: New)

States that map to DONE in SD Elements:

Comma-separated list of states in TFS/VSTS that will be mapped to DONE in SD Elements. (Default: Done)

Reopen a work item in TFS with the following status

Status to use to reopen closed issues (Default: New)

Iteration Path

Name of the iteration (Example: Iteration\ABC)

 If you create a new release and select the “Carry over ALM connections” option, you must manually edit the iteration path to ensure synchronization does not overwrite tasks in your previous TFS/VSTS iteration.*

Area Path

Name of the Area Path (Default: Project name)

Synchronization

Enter settings for synchronizing SD Elements tasks.

Authoritative Source

Select the tool that will be the authoritative system of record: TFS/VSTS or SD Elements. This field is used in case of conflicting statuses between the TFS/VSTS issue and the SD Elements task. When you first synchronize a TODO task in SD Elements with an issue in TFS/VSTS, they will have the same status. If you then change the status in one tool, for example by closing the issue in TFS/VSTS, they will have conflicting statuses. This conflict is resolved when the projects are synchronized. There are two options:

  • ALM (default): The SD Elements task will be updated to match the status in TFS/VSTS. This is relevant to most workflows.

  • SD Elements: The TFS/VSTS status will be updated to match the SD Elements status.

Include code sample How-To’s in task descriptions

Whether or not to include detailed code samples and How-To’s in the TFS/VSTS issue.

This server is not accessible from the SD Elements server

Select this option if SD Elements does not have direct network access to the TFS/VSTS server. For example, if you are using a hosted SD Elements instance but you want to integrate with an internal/protected TFS/VSTS system, choose this option and run the Remote Integration Client to perform integration.

Tasks to synchronize

Select the SD Elements tasks that are synchronized with the TFS/VSTS project.

Tasks having a minimum priority

Synchronize tasks with a minimum priority (for example, 7 or above). This is useful if you want to limit the amount of work for users. (Default: 7)

Tasks with status

Synchronize only tasks with certain statuses, such as TODO or DONE. (Default: TODO)

Tasks having phase

Synchronize only tasks in certain phases, such as Requirements or Development. (Default: Requirements, Architecture & Design, Development)

Tasks having all of the following tags

Synchronize only tasks containing certain SD Elements task tags. (Optional)

Tasks with verification status

Synchronize only tasks with a specific verification status, such as Pass or Fail. (Default: None, Partial Pass, Pass, Fail)

Advanced ALM options

Enter advanced configuration options.

ALM context

Bind a set of tasks using a cetain value. This is applicable only when custom titles are selected having the entry "Context"

ALM parent issue

The issue identifier of a parent issue. SD Elements tasks will be created as children of this issue.

Custom Priority Mapping

If the standard TFS/VSTS priorities have been customized, you must map the customized priority names in TFS/VSTS to their corresponding SD Elements numeric priorities.

 This is a common option that will need to be set.

For example, map "1" issues to priority 10 in SD Elements, "2" to priorities 7-9, and so on.

Custom Fields Mapping

In addition to the default-assigned fields, you can map additional SD Elements fields to TFS/VSTS fields.

 Fields that are not required or have default values do not need to be set.

For example, you may have a required field in your TFS/VSTS project that is not set by default. Custom field mappings can be set at both the system connection and project connection levels, and that mappings set in a project connection will override mappings set in the system connection.

For more details refer to section Advanced field support.

Sync frequency

Select how frequently the SD Elements and TFS/VSTS projects are synchronized. You can choose from the following options. The more frequently you run synchronization, the greater the performance impact on both the SD Elements and TFS/VSTS servers. This is generally only a concern for large organizations running many synchronizations at once.

Hourly, Daily, Weekly, or Monthly

The projects will synchronize automatically every hour, day, week or month. Daily synchronization is typically sufficient. However, you may want to select a more frequent interval if development moves quickly in your organization.

Manually

You must click the Sync button on the ALM Integrations page in order to synchronize the projects. This is the default value.

results matching ""

    No results matching ""